Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. synapse
  5. getKustoPoolAttachedDatabaseConfiguration
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.synapse.getKustoPoolAttachedDatabaseConfiguration

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns an attached database configuration. Azure REST API version: 2021-06-01-preview.

Using getKustoPoolAttachedDatabaseConfiguration

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 getKustoPoolAttachedDatabaseConfiguration(args: GetKustoPoolAttachedDatabaseConfigurationArgs, opts?: InvokeOptions): Promise<GetKustoPoolAttachedDatabaseConfigurationResult>
function getKustoPoolAttachedDatabaseConfigurationOutput(args: GetKustoPoolAttachedDatabaseConfigurationOutputArgs, opts?: InvokeOptions): Output<GetKustoPoolAttachedDatabaseConfigurationResult>
Copy
def get_kusto_pool_attached_database_configuration(attached_database_configuration_name: Optional[str] = None,
                                                   kusto_pool_name: Optional[str] = None,
                                                   resource_group_name: Optional[str] = None,
                                                   workspace_name: Optional[str] = None,
                                                   opts: Optional[InvokeOptions] = None) -> GetKustoPoolAttachedDatabaseConfigurationResult
def get_kusto_pool_attached_database_configuration_output(attached_database_configuration_name: Optional[pulumi.Input[str]] = None,
                                                   kusto_pool_name: Optional[pulumi.Input[str]] = None,
                                                   resource_group_name: Optional[pulumi.Input[str]] = None,
                                                   workspace_name: Optional[pulumi.Input[str]] = None,
                                                   opts: Optional[InvokeOptions] = None) -> Output[GetKustoPoolAttachedDatabaseConfigurationResult]
Copy
func LookupKustoPoolAttachedDatabaseConfiguration(ctx *Context, args *LookupKustoPoolAttachedDatabaseConfigurationArgs, opts ...InvokeOption) (*LookupKustoPoolAttachedDatabaseConfigurationResult, error)
func LookupKustoPoolAttachedDatabaseConfigurationOutput(ctx *Context, args *LookupKustoPoolAttachedDatabaseConfigurationOutputArgs, opts ...InvokeOption) LookupKustoPoolAttachedDatabaseConfigurationResultOutput
Copy

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

public static class GetKustoPoolAttachedDatabaseConfiguration 
{
    public static Task<GetKustoPoolAttachedDatabaseConfigurationResult> InvokeAsync(GetKustoPoolAttachedDatabaseConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetKustoPoolAttachedDatabaseConfigurationResult> Invoke(GetKustoPoolAttachedDatabaseConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetKustoPoolAttachedDatabaseConfigurationResult> getKustoPoolAttachedDatabaseConfiguration(GetKustoPoolAttachedDatabaseConfigurationArgs args, InvokeOptions options)
public static Output<GetKustoPoolAttachedDatabaseConfigurationResult> getKustoPoolAttachedDatabaseConfiguration(GetKustoPoolAttachedDatabaseConfigurationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:synapse:getKustoPoolAttachedDatabaseConfiguration
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AttachedDatabaseConfigurationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the attached database configuration.
KustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
AttachedDatabaseConfigurationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the attached database configuration.
KustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
attachedDatabaseConfigurationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the attached database configuration.
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto pool.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
attachedDatabaseConfigurationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the attached database configuration.
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
attached_database_configuration_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the attached database configuration.
kusto_pool_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto pool.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
attachedDatabaseConfigurationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the attached database configuration.
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto pool.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.

getKustoPoolAttachedDatabaseConfiguration Result

The following output properties are available:

AttachedDatabaseNames List<string>
The list of databases from the clusterResourceId which are currently attached to the kusto pool.
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}
KustoPoolResourceId string
The resource id of the kusto pool where the databases you would like to attach reside.
Name string
The name of the resource
ProvisioningState string
The provisioned state of the resource.
SystemData Pulumi.AzureNative.Synapse.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Location string
Resource location.
TableLevelSharingProperties Pulumi.AzureNative.Synapse.Outputs.TableLevelSharingPropertiesResponse
Table level sharing specifications
AttachedDatabaseNames []string
The list of databases from the clusterResourceId which are currently attached to the kusto pool.
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}
KustoPoolResourceId string
The resource id of the kusto pool where the databases you would like to attach reside.
Name string
The name of the resource
ProvisioningState string
The provisioned state of the resource.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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 kusto pool.
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}
kustoPoolResourceId String
The resource id of the kusto pool where the databases you would like to attach reside.
name String
The name of the resource
provisioningState String
The provisioned state of the resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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 kusto pool.
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}
kustoPoolResourceId string
The resource id of the kusto pool where the databases you would like to attach reside.
name string
The name of the resource
provisioningState string
The provisioned state of the resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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 kusto pool.
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}
kusto_pool_resource_id str
The resource id of the kusto pool where the databases you would like to attach reside.
name str
The name of the resource
provisioning_state str
The provisioned state of the resource.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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 kusto pool.
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}
kustoPoolResourceId String
The resource id of the kusto pool where the databases you would like to attach reside.
name String
The name of the resource
provisioningState String
The provisioned state of the resource.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
location String
Resource location.
tableLevelSharingProperties Property Map
Table level sharing specifications

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
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_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

TableLevelSharingPropertiesResponse

ExternalTablesToExclude List<string>
List of external tables exclude from the follower database
ExternalTablesToInclude List<string>
List of external tables to include in the follower database
MaterializedViewsToExclude List<string>
List of materialized views 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 exclude from the follower database
ExternalTablesToInclude []string
List of external tables to include in the follower database
MaterializedViewsToExclude []string
List of materialized views 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 exclude from the follower database
externalTablesToInclude List<String>
List of external tables to include in the follower database
materializedViewsToExclude List<String>
List of materialized views 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 exclude from the follower database
externalTablesToInclude string[]
List of external tables to include in the follower database
materializedViewsToExclude string[]
List of materialized views 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 exclude from the follower database
external_tables_to_include Sequence[str]
List of external tables to include in the follower database
materialized_views_to_exclude Sequence[str]
List of materialized views 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 exclude from the follower database
externalTablesToInclude List<String>
List of external tables to include in the follower database
materializedViewsToExclude List<String>
List of materialized views 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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native