Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. kusto
  5. getCosmosDbDataConnection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.kusto.getCosmosDbDataConnection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

    Returns a data connection. Azure REST API version: 2022-12-29.

    Using getCosmosDbDataConnection

    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 getCosmosDbDataConnection(args: GetCosmosDbDataConnectionArgs, opts?: InvokeOptions): Promise<GetCosmosDbDataConnectionResult>
function getCosmosDbDataConnectionOutput(args: GetCosmosDbDataConnectionOutputArgs, opts?: InvokeOptions): Output<GetCosmosDbDataConnectionResult>
    def get_cosmos_db_data_connection(cluster_name: Optional[str] = None,
                                  data_connection_name: Optional[str] = None,
                                  database_name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetCosmosDbDataConnectionResult
def get_cosmos_db_data_connection_output(cluster_name: Optional[pulumi.Input[str]] = None,
                                  data_connection_name: Optional[pulumi.Input[str]] = None,
                                  database_name: Optional[pulumi.Input[str]] = None,
                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetCosmosDbDataConnectionResult]
    func LookupCosmosDbDataConnection(ctx *Context, args *LookupCosmosDbDataConnectionArgs, opts ...InvokeOption) (*LookupCosmosDbDataConnectionResult, error)
func LookupCosmosDbDataConnectionOutput(ctx *Context, args *LookupCosmosDbDataConnectionOutputArgs, opts ...InvokeOption) LookupCosmosDbDataConnectionResultOutput

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

    public static class GetCosmosDbDataConnection 
{
    public static Task<GetCosmosDbDataConnectionResult> InvokeAsync(GetCosmosDbDataConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetCosmosDbDataConnectionResult> Invoke(GetCosmosDbDataConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCosmosDbDataConnectionResult> getCosmosDbDataConnection(GetCosmosDbDataConnectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:kusto:getCosmosDbDataConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterName string
    The name of the Kusto cluster.
    DataConnectionName string
    The name of the data connection.
    DatabaseName string
    The name of the database in the Kusto cluster.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    ClusterName string
    The name of the Kusto cluster.
    DataConnectionName string
    The name of the data connection.
    DatabaseName string
    The name of the database in the Kusto cluster.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    clusterName String
    The name of the Kusto cluster.
    dataConnectionName String
    The name of the data connection.
    databaseName String
    The name of the database in the Kusto cluster.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.
    clusterName string
    The name of the Kusto cluster.
    dataConnectionName string
    The name of the data connection.
    databaseName string
    The name of the database in the Kusto cluster.
    resourceGroupName string
    The name of the resource group containing the Kusto cluster.
    cluster_name str
    The name of the Kusto cluster.
    data_connection_name str
    The name of the data connection.
    database_name str
    The name of the database in the Kusto cluster.
    resource_group_name str
    The name of the resource group containing the Kusto cluster.
    clusterName String
    The name of the Kusto cluster.
    dataConnectionName String
    The name of the data connection.
    databaseName String
    The name of the database in the Kusto cluster.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.

    getCosmosDbDataConnection Result

    The following output properties are available:

    CosmosDbAccountResourceId string
    The resource ID of the Cosmos DB account used to create the data connection.
    CosmosDbContainer string
    The name of an existing container in the Cosmos DB database.
    CosmosDbDatabase string
    The name of an existing database in the Cosmos DB account.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ManagedIdentityObjectId string
    The object ID of the managed identity resource.
    ManagedIdentityResourceId string
    The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioned state of the resource.
    TableName string
    The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Location string
    Resource location.
    MappingRuleName string
    The name of an existing mapping rule to use when ingesting the retrieved data.
    RetrievalStartDate string
    Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
    CosmosDbAccountResourceId string
    The resource ID of the Cosmos DB account used to create the data connection.
    CosmosDbContainer string
    The name of an existing container in the Cosmos DB database.
    CosmosDbDatabase string
    The name of an existing database in the Cosmos DB account.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ManagedIdentityObjectId string
    The object ID of the managed identity resource.
    ManagedIdentityResourceId string
    The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioned state of the resource.
    TableName string
    The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Location string
    Resource location.
    MappingRuleName string
    The name of an existing mapping rule to use when ingesting the retrieved data.
    RetrievalStartDate string
    Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
    cosmosDbAccountResourceId String
    The resource ID of the Cosmos DB account used to create the data connection.
    cosmosDbContainer String
    The name of an existing container in the Cosmos DB database.
    cosmosDbDatabase String
    The name of an existing database in the Cosmos DB account.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    managedIdentityObjectId String
    The object ID of the managed identity resource.
    managedIdentityResourceId String
    The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
    name String
    The name of the resource
    provisioningState String
    The provisioned state of the resource.
    tableName String
    The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    location String
    Resource location.
    mappingRuleName String
    The name of an existing mapping rule to use when ingesting the retrieved data.
    retrievalStartDate String
    Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
    cosmosDbAccountResourceId string
    The resource ID of the Cosmos DB account used to create the data connection.
    cosmosDbContainer string
    The name of an existing container in the Cosmos DB database.
    cosmosDbDatabase string
    The name of an existing database in the Cosmos DB account.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    managedIdentityObjectId string
    The object ID of the managed identity resource.
    managedIdentityResourceId string
    The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
    name string
    The name of the resource
    provisioningState string
    The provisioned state of the resource.
    tableName string
    The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    location string
    Resource location.
    mappingRuleName string
    The name of an existing mapping rule to use when ingesting the retrieved data.
    retrievalStartDate string
    Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
    cosmos_db_account_resource_id str
    The resource ID of the Cosmos DB account used to create the data connection.
    cosmos_db_container str
    The name of an existing container in the Cosmos DB database.
    cosmos_db_database str
    The name of an existing database in the Cosmos DB account.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    managed_identity_object_id str
    The object ID of the managed identity resource.
    managed_identity_resource_id str
    The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
    name str
    The name of the resource
    provisioning_state str
    The provisioned state of the resource.
    table_name str
    The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    location str
    Resource location.
    mapping_rule_name str
    The name of an existing mapping rule to use when ingesting the retrieved data.
    retrieval_start_date str
    Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
    cosmosDbAccountResourceId String
    The resource ID of the Cosmos DB account used to create the data connection.
    cosmosDbContainer String
    The name of an existing container in the Cosmos DB database.
    cosmosDbDatabase String
    The name of an existing database in the Cosmos DB account.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    managedIdentityObjectId String
    The object ID of the managed identity resource.
    managedIdentityResourceId String
    The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
    name String
    The name of the resource
    provisioningState String
    The provisioned state of the resource.
    tableName String
    The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    location String
    Resource location.
    mappingRuleName String
    The name of an existing mapping rule to use when ingesting the retrieved data.
    retrievalStartDate String
    Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-azure-native