Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. kusto
  5. getAttachedDatabaseConfiguration
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.89.3 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.kusto.getAttachedDatabaseConfiguration

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.89.3 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-azure-native

    Returns an attached database configuration. Azure REST API version: 2022-12-29.

    Other available API versions: 2023-05-02, 2023-08-15, 2024-04-13.

    Using getAttachedDatabaseConfiguration

    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 getAttachedDatabaseConfiguration(args: GetAttachedDatabaseConfigurationArgs, opts?: InvokeOptions): Promise<GetAttachedDatabaseConfigurationResult>
function getAttachedDatabaseConfigurationOutput(args: GetAttachedDatabaseConfigurationOutputArgs, opts?: InvokeOptions): Output<GetAttachedDatabaseConfigurationResult>
    def get_attached_database_configuration(attached_database_configuration_name: Optional[str] = None,
                                        cluster_name: Optional[str] = None,
                                        resource_group_name: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetAttachedDatabaseConfigurationResult
def get_attached_database_configuration_output(attached_database_configuration_name: Optional[pulumi.Input[str]] = None,
                                        cluster_name: Optional[pulumi.Input[str]] = None,
                                        resource_group_name: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetAttachedDatabaseConfigurationResult]
    func LookupAttachedDatabaseConfiguration(ctx *Context, args *LookupAttachedDatabaseConfigurationArgs, opts ...InvokeOption) (*LookupAttachedDatabaseConfigurationResult, error)
func LookupAttachedDatabaseConfigurationOutput(ctx *Context, args *LookupAttachedDatabaseConfigurationOutputArgs, opts ...InvokeOption) LookupAttachedDatabaseConfigurationResultOutput

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

    public static class GetAttachedDatabaseConfiguration 
{
    public static Task<GetAttachedDatabaseConfigurationResult> InvokeAsync(GetAttachedDatabaseConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetAttachedDatabaseConfigurationResult> Invoke(GetAttachedDatabaseConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAttachedDatabaseConfigurationResult> getAttachedDatabaseConfiguration(GetAttachedDatabaseConfigurationArgs args, InvokeOptions options)
public static Output<GetAttachedDatabaseConfigurationResult> getAttachedDatabaseConfiguration(GetAttachedDatabaseConfigurationArgs args, InvokeOptions options)

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

    The following arguments are supported:

    AttachedDatabaseConfigurationName string
    The name of the attached database configuration.
    ClusterName string
    The name of the Kusto cluster.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    AttachedDatabaseConfigurationName string
    The name of the attached database configuration.
    ClusterName string
    The name of the Kusto cluster.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    attachedDatabaseConfigurationName String
    The name of the attached database configuration.
    clusterName String
    The name of the Kusto cluster.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.
    attachedDatabaseConfigurationName string
    The name of the attached database configuration.
    clusterName string
    The name of the Kusto cluster.
    resourceGroupName string
    The name of the resource group containing the Kusto cluster.
    attached_database_configuration_name str
    The name of the attached database configuration.
    cluster_name str
    The name of the Kusto cluster.
    resource_group_name str
    The name of the resource group containing the Kusto cluster.
    attachedDatabaseConfigurationName String
    The name of the attached database configuration.
    clusterName String
    The name of the Kusto cluster.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.

    getAttachedDatabaseConfiguration Result

    The following output properties are available:

    AttachedDatabaseNames List<string>
    The list of databases from the clusterResourceId which are currently attached to the cluster.
    ClusterResourceId string
    The resource id of the cluster where the databases you would like to attach reside.
    DatabaseName string
    The name of the database which you would like to attach, use * if you want to follow all current and future databases.
    DefaultPrincipalsModificationKind string
    The default principals modification kind
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    ProvisioningState string
    The provisioned state of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    DatabaseNameOverride string
    Overrides the original database name. Relevant only when attaching to a specific database.
    DatabaseNamePrefix string
    Adds a prefix to the attached databases name. When following an entire cluster, that prefix would be added to all of the databases original names from leader cluster.
    Location string
    Resource location.
    TableLevelSharingProperties Pulumi.AzureNative.Kusto.Outputs.TableLevelSharingPropertiesResponse
    Table level sharing specifications
    AttachedDatabaseNames []string
    The list of databases from the clusterResourceId which are currently attached to the cluster.
    ClusterResourceId string
    The resource id of the cluster where the databases you would like to attach reside.
    DatabaseName string
    The name of the database which you would like to attach, use * if you want to follow all current and future databases.
    DefaultPrincipalsModificationKind string
    The default principals modification kind
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    ProvisioningState string
    The provisioned state of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    DatabaseNameOverride string
    Overrides the original database name. Relevant only when attaching to a specific database.
    DatabaseNamePrefix string
    Adds a prefix to the attached databases name. When following an entire cluster, that prefix would be added to all of the databases original names from leader cluster.
    Location string
    Resource location.
    TableLevelSharingProperties TableLevelSharingPropertiesResponse
    Table level sharing specifications
    attachedDatabaseNames List<String>
    The list of databases from the clusterResourceId which are currently attached to the cluster.
    clusterResourceId String
    The resource id of the cluster where the databases you would like to attach reside.
    databaseName String
    The name of the database which you would like to attach, use * if you want to follow all current and future databases.
    defaultPrincipalsModificationKind String
    The default principals modification kind
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    provisioningState String
    The provisioned state of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    databaseNameOverride String
    Overrides the original database name. Relevant only when attaching to a specific database.
    databaseNamePrefix String
    Adds a prefix to the attached databases name. When following an entire cluster, that prefix would be added to all of the databases original names from leader cluster.
    location String
    Resource location.
    tableLevelSharingProperties TableLevelSharingPropertiesResponse
    Table level sharing specifications
    attachedDatabaseNames string[]
    The list of databases from the clusterResourceId which are currently attached to the cluster.
    clusterResourceId string
    The resource id of the cluster where the databases you would like to attach reside.
    databaseName string
    The name of the database which you would like to attach, use * if you want to follow all current and future databases.
    defaultPrincipalsModificationKind string
    The default principals modification kind
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    provisioningState string
    The provisioned state of the resource.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    databaseNameOverride string
    Overrides the original database name. Relevant only when attaching to a specific database.
    databaseNamePrefix string
    Adds a prefix to the attached databases name. When following an entire cluster, that prefix would be added to all of the databases original names from leader cluster.
    location string
    Resource location.
    tableLevelSharingProperties TableLevelSharingPropertiesResponse
    Table level sharing specifications
    attached_database_names Sequence[str]
    The list of databases from the clusterResourceId which are currently attached to the cluster.
    cluster_resource_id str
    The resource id of the cluster where the databases you would like to attach reside.
    database_name str
    The name of the database which you would like to attach, use * if you want to follow all current and future databases.
    default_principals_modification_kind str
    The default principals modification kind
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    provisioning_state str
    The provisioned state of the resource.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    database_name_override str
    Overrides the original database name. Relevant only when attaching to a specific database.
    database_name_prefix str
    Adds a prefix to the attached databases name. When following an entire cluster, that prefix would be added to all of the databases original names from leader cluster.
    location str
    Resource location.
    table_level_sharing_properties TableLevelSharingPropertiesResponse
    Table level sharing specifications
    attachedDatabaseNames List<String>
    The list of databases from the clusterResourceId which are currently attached to the cluster.
    clusterResourceId String
    The resource id of the cluster where the databases you would like to attach reside.
    databaseName String
    The name of the database which you would like to attach, use * if you want to follow all current and future databases.
    defaultPrincipalsModificationKind String
    The default principals modification kind
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    provisioningState String
    The provisioned state of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    databaseNameOverride String
    Overrides the original database name. Relevant only when attaching to a specific database.
    databaseNamePrefix String
    Adds a prefix to the attached databases name. When following an entire cluster, that prefix would be added to all of the databases original names from leader cluster.
    location String
    Resource location.
    tableLevelSharingProperties Property Map
    Table level sharing specifications

    Supporting Types

    TableLevelSharingPropertiesResponse

    ExternalTablesToExclude List<string>
    List of external tables to exclude from the follower database
    ExternalTablesToInclude List<string>
    List of external tables to include in the follower database
    FunctionsToExclude List<string>
    List of functions to exclude from the follower database
    FunctionsToInclude List<string>
    List of functions to include in the follower database
    MaterializedViewsToExclude List<string>
    List of materialized views to exclude from the follower database
    MaterializedViewsToInclude List<string>
    List of materialized views to include in the follower database
    TablesToExclude List<string>
    List of tables to exclude from the follower database
    TablesToInclude List<string>
    List of tables to include in the follower database
    ExternalTablesToExclude []string
    List of external tables to exclude from the follower database
    ExternalTablesToInclude []string
    List of external tables to include in the follower database
    FunctionsToExclude []string
    List of functions to exclude from the follower database
    FunctionsToInclude []string
    List of functions to include in the follower database
    MaterializedViewsToExclude []string
    List of materialized views to exclude from the follower database
    MaterializedViewsToInclude []string
    List of materialized views to include in the follower database
    TablesToExclude []string
    List of tables to exclude from the follower database
    TablesToInclude []string
    List of tables to include in the follower database
    externalTablesToExclude List<String>
    List of external tables to exclude from the follower database
    externalTablesToInclude List<String>
    List of external tables to include in the follower database
    functionsToExclude List<String>
    List of functions to exclude from the follower database
    functionsToInclude List<String>
    List of functions to include in the follower database
    materializedViewsToExclude List<String>
    List of materialized views to exclude from the follower database
    materializedViewsToInclude List<String>
    List of materialized views to include in the follower database
    tablesToExclude List<String>
    List of tables to exclude from the follower database
    tablesToInclude List<String>
    List of tables to include in the follower database
    externalTablesToExclude string[]
    List of external tables to exclude from the follower database
    externalTablesToInclude string[]
    List of external tables to include in the follower database
    functionsToExclude string[]
    List of functions to exclude from the follower database
    functionsToInclude string[]
    List of functions to include in the follower database
    materializedViewsToExclude string[]
    List of materialized views to exclude from the follower database
    materializedViewsToInclude string[]
    List of materialized views to include in the follower database
    tablesToExclude string[]
    List of tables to exclude from the follower database
    tablesToInclude string[]
    List of tables to include in the follower database
    external_tables_to_exclude Sequence[str]
    List of external tables to exclude from the follower database
    external_tables_to_include Sequence[str]
    List of external tables to include in the follower database
    functions_to_exclude Sequence[str]
    List of functions to exclude from the follower database
    functions_to_include Sequence[str]
    List of functions to include in the follower database
    materialized_views_to_exclude Sequence[str]
    List of materialized views to exclude from the follower database
    materialized_views_to_include Sequence[str]
    List of materialized views to include in the follower database
    tables_to_exclude Sequence[str]
    List of tables to exclude from the follower database
    tables_to_include Sequence[str]
    List of tables to include in the follower database
    externalTablesToExclude List<String>
    List of external tables to exclude from the follower database
    externalTablesToInclude List<String>
    List of external tables to include in the follower database
    functionsToExclude List<String>
    List of functions to exclude from the follower database
    functionsToInclude List<String>
    List of functions to include in the follower database
    materializedViewsToExclude List<String>
    List of materialized views to exclude from the follower database
    materializedViewsToInclude List<String>
    List of materialized views to include in the follower database
    tablesToExclude List<String>
    List of tables to exclude from the follower database
    tablesToInclude List<String>
    List of tables to include in the follower database

    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.89.3 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-azure-native