pulumi-azure-native-kotlin/com.pulumi.azurenative.kusto.kotlin/CosmosDbDataConnection

CosmosDbDataConnection

class CosmosDbDataConnection : KotlinCustomResource

Class representing a CosmosDb data connection. Uses Azure REST API version 2024-04-13. In version 2.x of the Azure Native provider, it used API version 2022-12-29.

Example Usage

KustoDataConnectionsCosmosDbCreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var cosmosDbDataConnection = new AzureNative.Kusto.CosmosDbDataConnection("cosmosDbDataConnection", new()
    {
        ClusterName = "kustoCluster",
        CosmosDbAccountResourceId = "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.DocumentDb/databaseAccounts/cosmosDbAccountTest1",
        CosmosDbContainer = "cosmosDbContainerTest",
        CosmosDbDatabase = "cosmosDbDatabaseTest",
        DataConnectionName = "dataConnectionTest",
        DatabaseName = "KustoDatabase1",
        Kind = "CosmosDb",
        Location = "westus",
        ManagedIdentityResourceId = "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1",
        MappingRuleName = "TestMapping",
        ResourceGroupName = "kustorptest",
        RetrievalStartDate = "2022-07-29T12:00:00.6554616Z",
        TableName = "TestTable",
    });
});
Content copied to clipboard
package main
import (
	kusto "github.com/pulumi/pulumi-azure-native-sdk/kusto/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kusto.NewCosmosDbDataConnection(ctx, "cosmosDbDataConnection", &kusto.CosmosDbDataConnectionArgs{
			ClusterName:               pulumi.String("kustoCluster"),
			CosmosDbAccountResourceId: pulumi.String("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.DocumentDb/databaseAccounts/cosmosDbAccountTest1"),
			CosmosDbContainer:         pulumi.String("cosmosDbContainerTest"),
			CosmosDbDatabase:          pulumi.String("cosmosDbDatabaseTest"),
			DataConnectionName:        pulumi.String("dataConnectionTest"),
			DatabaseName:              pulumi.String("KustoDatabase1"),
			Kind:                      pulumi.String("CosmosDb"),
			Location:                  pulumi.String("westus"),
			ManagedIdentityResourceId: pulumi.String("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
			MappingRuleName:           pulumi.String("TestMapping"),
			ResourceGroupName:         pulumi.String("kustorptest"),
			RetrievalStartDate:        pulumi.String("2022-07-29T12:00:00.6554616Z"),
			TableName:                 pulumi.String("TestTable"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.kusto.CosmosDbDataConnection;
import com.pulumi.azurenative.kusto.CosmosDbDataConnectionArgs;
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 cosmosDbDataConnection = new CosmosDbDataConnection("cosmosDbDataConnection", CosmosDbDataConnectionArgs.builder()
            .clusterName("kustoCluster")
            .cosmosDbAccountResourceId("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.DocumentDb/databaseAccounts/cosmosDbAccountTest1")
            .cosmosDbContainer("cosmosDbContainerTest")
            .cosmosDbDatabase("cosmosDbDatabaseTest")
            .dataConnectionName("dataConnectionTest")
            .databaseName("KustoDatabase1")
            .kind("CosmosDb")
            .location("westus")
            .managedIdentityResourceId("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1")
            .mappingRuleName("TestMapping")
            .resourceGroupName("kustorptest")
            .retrievalStartDate("2022-07-29T12:00:00.6554616Z")
            .tableName("TestTable")
            .build());
    }
}
Content copied to clipboard

KustoDataConnectionsCreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var cosmosDbDataConnection = new AzureNative.Kusto.CosmosDbDataConnection("cosmosDbDataConnection", new()
    {
        ClusterName = "kustoCluster",
        DataConnectionName = "dataConnectionTest",
        DatabaseName = "KustoDatabase8",
        ResourceGroupName = "kustorptest",
    });
});
Content copied to clipboard
package main
import (
	kusto "github.com/pulumi/pulumi-azure-native-sdk/kusto/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kusto.NewCosmosDbDataConnection(ctx, "cosmosDbDataConnection", &kusto.CosmosDbDataConnectionArgs{
			ClusterName:        pulumi.String("kustoCluster"),
			DataConnectionName: pulumi.String("dataConnectionTest"),
			DatabaseName:       pulumi.String("KustoDatabase8"),
			ResourceGroupName:  pulumi.String("kustorptest"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.kusto.CosmosDbDataConnection;
import com.pulumi.azurenative.kusto.CosmosDbDataConnectionArgs;
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 cosmosDbDataConnection = new CosmosDbDataConnection("cosmosDbDataConnection", CosmosDbDataConnectionArgs.builder()
            .clusterName("kustoCluster")
            .dataConnectionName("dataConnectionTest")
            .databaseName("KustoDatabase8")
            .resourceGroupName("kustorptest")
            .build());
    }
}
Content copied to clipboard

KustoDataConnectionsEventGridCreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var cosmosDbDataConnection = new AzureNative.Kusto.CosmosDbDataConnection("cosmosDbDataConnection", new()
    {
        ClusterName = "kustoCluster",
        DataConnectionName = "dataConnectionTest",
        DatabaseName = "KustoDatabase8",
        ResourceGroupName = "kustorptest",
    });
});
Content copied to clipboard
package main
import (
	kusto "github.com/pulumi/pulumi-azure-native-sdk/kusto/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kusto.NewCosmosDbDataConnection(ctx, "cosmosDbDataConnection", &kusto.CosmosDbDataConnectionArgs{
			ClusterName:        pulumi.String("kustoCluster"),
			DataConnectionName: pulumi.String("dataConnectionTest"),
			DatabaseName:       pulumi.String("KustoDatabase8"),
			ResourceGroupName:  pulumi.String("kustorptest"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.kusto.CosmosDbDataConnection;
import com.pulumi.azurenative.kusto.CosmosDbDataConnectionArgs;
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 cosmosDbDataConnection = new CosmosDbDataConnection("cosmosDbDataConnection", CosmosDbDataConnectionArgs.builder()
            .clusterName("kustoCluster")
            .dataConnectionName("dataConnectionTest")
            .databaseName("KustoDatabase8")
            .resourceGroupName("kustorptest")
            .build());
    }
}
Content copied to clipboard

Import

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

$ pulumi import azure-native:kusto:CosmosDbDataConnection kustoCluster/KustoDatabase8/dataConnectionTest /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}
Content copied to clipboard

Properties

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val cosmosDbAccountResourceId: Output<String>

The resource ID of the Cosmos DB account used to create the data connection.

Link copied to clipboard
val cosmosDbContainer: Output<String>

The name of an existing container in the Cosmos DB database.

Link copied to clipboard
val cosmosDbDatabase: Output<String>

The name of an existing database in the Cosmos DB account.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val kind: Output<String>

Kind of the endpoint for the data connection Expected value is 'CosmosDb'.

Link copied to clipboard
val location: Output<String>?

Resource location.

Link copied to clipboard
val managedIdentityObjectId: Output<String>

The object ID of the managed identity resource.

Link copied to clipboard
val managedIdentityResourceId: Output<String>

The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.

Link copied to clipboard
val mappingRuleName: Output<String>?

The name of an existing mapping rule to use when ingesting the retrieved data.

Link copied to clipboard
val name: Output<String>

The name of the resource

Link copied to clipboard
val provisioningState: Output<String>

The provisioned state of the resource.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val retrievalStartDate: Output<String>?

Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.

Link copied to clipboard
val tableName: Output<String>

The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.

Link copied to clipboard
val type: Output<String>

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard
val urn: Output<String>