Package com.pulumi.azurenative.kusto

Class CosmosDbDataConnection

  • public class CosmosDbDataConnection
extends com.pulumi.resources.CustomResource
    Class representing a CosmosDb data connection. Azure REST API version: 2022-12-29. Prior API version in Azure Native 1.x: 2021-01-01. ## Example Usage ### KustoDataConnectionsCosmosDbCreateOrUpdate ```java 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()); } } ``` ### KustoDataConnectionsCreateOrUpdate ```java 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()); } } ``` ### KustoDataConnectionsEventGridCreateOrUpdate ```java 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()); } } ``` ## Import An existing resource can be imported using its type token, name, and identifier, e.g. ```sh $ pulumi import azure-native:kusto:CosmosDbDataConnection kustoCluster/KustoDatabase8/dataConnectionTest /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName} ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> cosmosDbAccountResourceId()  
      com.pulumi.core.Output<java.lang.String> cosmosDbContainer()  
      com.pulumi.core.Output<java.lang.String> cosmosDbDatabase()  
      static CosmosDbDataConnection get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> kind()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> location()  
      com.pulumi.core.Output<java.lang.String> managedIdentityObjectId()  
      com.pulumi.core.Output<java.lang.String> managedIdentityResourceId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> mappingRuleName()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> provisioningState()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> retrievalStartDate()  
      com.pulumi.core.Output<java.lang.String> tableName()  
      com.pulumi.core.Output<java.lang.String> type()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CosmosDbDataConnection

        public CosmosDbDataConnection​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • CosmosDbDataConnection

        public CosmosDbDataConnection​(java.lang.String name,
                              CosmosDbDataConnectionArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • CosmosDbDataConnection

        public CosmosDbDataConnection​(java.lang.String name,
                              CosmosDbDataConnectionArgs args,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • cosmosDbAccountResourceId

        public com.pulumi.core.Output<java.lang.String> cosmosDbAccountResourceId()
        Returns:
        The resource ID of the Cosmos DB account used to create the data connection.

      • cosmosDbContainer

        public com.pulumi.core.Output<java.lang.String> cosmosDbContainer()
        Returns:
        The name of an existing container in the Cosmos DB database.

      • cosmosDbDatabase

        public com.pulumi.core.Output<java.lang.String> cosmosDbDatabase()
        Returns:
        The name of an existing database in the Cosmos DB account.

      • kind

        public com.pulumi.core.Output<java.lang.String> kind()
        Returns:
        Kind of the endpoint for the data connection Expected value is 'CosmosDb'.

      • location

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> location()
        Returns:
        Resource location.

      • managedIdentityObjectId

        public com.pulumi.core.Output<java.lang.String> managedIdentityObjectId()
        Returns:
        The object ID of the managed identity resource.

      • managedIdentityResourceId

        public com.pulumi.core.Output<java.lang.String> managedIdentityResourceId()
        Returns:
        The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.

      • mappingRuleName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> mappingRuleName()
        Returns:
        The name of an existing mapping rule to use when ingesting the retrieved data.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the resource

      • provisioningState

        public com.pulumi.core.Output<java.lang.String> provisioningState()
        Returns:
        The provisioned state of the resource.

      • retrievalStartDate

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> retrievalStartDate()
        Returns:
        Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.

      • tableName

        public com.pulumi.core.Output<java.lang.String> tableName()
        Returns:
        The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

      • get

        public static CosmosDbDataConnection get​(java.lang.String name,
                                         com.pulumi.core.Output<java.lang.String> id,
                                         @Nullable
                                         com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        options - Optional settings to control the behavior of the CustomResource.