azure-native-v2.synapse.KustoPoolAttachedDatabaseConfiguration
Explore with Pulumi AI
Class representing an attached database configuration. Azure REST API version: 2021-06-01-preview. Prior API version in Azure Native 1.x: 2021-06-01-preview.
Create KustoPoolAttachedDatabaseConfiguration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KustoPoolAttachedDatabaseConfiguration(name: string, args: KustoPoolAttachedDatabaseConfigurationArgs, opts?: CustomResourceOptions);
@overload
def KustoPoolAttachedDatabaseConfiguration(resource_name: str,
args: KustoPoolAttachedDatabaseConfigurationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def KustoPoolAttachedDatabaseConfiguration(resource_name: str,
opts: Optional[ResourceOptions] = None,
database_name: Optional[str] = None,
default_principals_modification_kind: Optional[Union[str, DefaultPrincipalsModificationKind]] = None,
kusto_pool_name: Optional[str] = None,
kusto_pool_resource_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
workspace_name: Optional[str] = None,
attached_database_configuration_name: Optional[str] = None,
location: Optional[str] = None,
table_level_sharing_properties: Optional[TableLevelSharingPropertiesArgs] = None)
func NewKustoPoolAttachedDatabaseConfiguration(ctx *Context, name string, args KustoPoolAttachedDatabaseConfigurationArgs, opts ...ResourceOption) (*KustoPoolAttachedDatabaseConfiguration, error)
public KustoPoolAttachedDatabaseConfiguration(string name, KustoPoolAttachedDatabaseConfigurationArgs args, CustomResourceOptions? opts = null)
public KustoPoolAttachedDatabaseConfiguration(String name, KustoPoolAttachedDatabaseConfigurationArgs args)
public KustoPoolAttachedDatabaseConfiguration(String name, KustoPoolAttachedDatabaseConfigurationArgs args, CustomResourceOptions options)
type: azure-native:synapse:KustoPoolAttachedDatabaseConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. KustoPoolAttachedDatabaseConfigurationArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. KustoPoolAttachedDatabaseConfigurationArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. KustoPoolAttachedDatabaseConfigurationArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. KustoPoolAttachedDatabaseConfigurationArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. KustoPoolAttachedDatabaseConfigurationArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var kustoPoolAttachedDatabaseConfigurationResource = new AzureNative.Synapse.KustoPoolAttachedDatabaseConfiguration("kustoPoolAttachedDatabaseConfigurationResource", new()
{
DatabaseName = "string",
DefaultPrincipalsModificationKind = "string",
KustoPoolName = "string",
KustoPoolResourceId = "string",
ResourceGroupName = "string",
WorkspaceName = "string",
AttachedDatabaseConfigurationName = "string",
Location = "string",
TableLevelSharingProperties =
{
{ "externalTablesToExclude", new[]
{
"string",
} },
{ "externalTablesToInclude", new[]
{
"string",
} },
{ "materializedViewsToExclude", new[]
{
"string",
} },
{ "materializedViewsToInclude", new[]
{
"string",
} },
{ "tablesToExclude", new[]
{
"string",
} },
{ "tablesToInclude", new[]
{
"string",
} },
},
});
example, err := synapse.NewKustoPoolAttachedDatabaseConfiguration(ctx, "kustoPoolAttachedDatabaseConfigurationResource", &synapse.KustoPoolAttachedDatabaseConfigurationArgs{
DatabaseName: "string",
DefaultPrincipalsModificationKind: "string",
KustoPoolName: "string",
KustoPoolResourceId: "string",
ResourceGroupName: "string",
WorkspaceName: "string",
AttachedDatabaseConfigurationName: "string",
Location: "string",
TableLevelSharingProperties: map[string]interface{}{
"externalTablesToExclude": []string{
"string",
},
"externalTablesToInclude": []string{
"string",
},
"materializedViewsToExclude": []string{
"string",
},
"materializedViewsToInclude": []string{
"string",
},
"tablesToExclude": []string{
"string",
},
"tablesToInclude": []string{
"string",
},
},
})
var kustoPoolAttachedDatabaseConfigurationResource = new KustoPoolAttachedDatabaseConfiguration("kustoPoolAttachedDatabaseConfigurationResource", KustoPoolAttachedDatabaseConfigurationArgs.builder()
.databaseName("string")
.defaultPrincipalsModificationKind("string")
.kustoPoolName("string")
.kustoPoolResourceId("string")
.resourceGroupName("string")
.workspaceName("string")
.attachedDatabaseConfigurationName("string")
.location("string")
.tableLevelSharingProperties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
kusto_pool_attached_database_configuration_resource = azure_native.synapse.KustoPoolAttachedDatabaseConfiguration("kustoPoolAttachedDatabaseConfigurationResource",
database_name=string,
default_principals_modification_kind=string,
kusto_pool_name=string,
kusto_pool_resource_id=string,
resource_group_name=string,
workspace_name=string,
attached_database_configuration_name=string,
location=string,
table_level_sharing_properties={
externalTablesToExclude: [string],
externalTablesToInclude: [string],
materializedViewsToExclude: [string],
materializedViewsToInclude: [string],
tablesToExclude: [string],
tablesToInclude: [string],
})
const kustoPoolAttachedDatabaseConfigurationResource = new azure_native.synapse.KustoPoolAttachedDatabaseConfiguration("kustoPoolAttachedDatabaseConfigurationResource", {
databaseName: "string",
defaultPrincipalsModificationKind: "string",
kustoPoolName: "string",
kustoPoolResourceId: "string",
resourceGroupName: "string",
workspaceName: "string",
attachedDatabaseConfigurationName: "string",
location: "string",
tableLevelSharingProperties: {
externalTablesToExclude: ["string"],
externalTablesToInclude: ["string"],
materializedViewsToExclude: ["string"],
materializedViewsToInclude: ["string"],
tablesToExclude: ["string"],
tablesToInclude: ["string"],
},
});
type: azure-native:synapse:KustoPoolAttachedDatabaseConfiguration
properties:
attachedDatabaseConfigurationName: string
databaseName: string
defaultPrincipalsModificationKind: string
kustoPoolName: string
kustoPoolResourceId: string
location: string
resourceGroupName: string
tableLevelSharingProperties:
externalTablesToExclude:
- string
externalTablesToInclude:
- string
materializedViewsToExclude:
- string
materializedViewsToInclude:
- string
tablesToExclude:
- string
tablesToInclude:
- string
workspaceName: string
KustoPoolAttachedDatabaseConfiguration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The KustoPoolAttachedDatabaseConfiguration resource accepts the following input properties:
- Database
Name This property is required. string - 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 This property is required. string | Pulumi.Azure Native. Synapse. Default Principals Modification Kind - The default principals modification kind
- Kusto
Pool Name This property is required. Changes to this property will trigger replacement.
- The name of the Kusto pool.
- Kusto
Pool Resource Id This property is required. string - The resource id of the kusto pool where the databases you would like to attach reside.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- Attached
Database Configuration Name Changes to this property will trigger replacement.
- The name of the attached database configuration.
- Location string
- Resource location.
- Table
Level Pulumi.Sharing Properties Azure Native. Synapse. Inputs. Table Level Sharing Properties - Table level sharing specifications
- Database
Name This property is required. string - 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 This property is required. string | DefaultPrincipals Modification Kind - The default principals modification kind
- Kusto
Pool Name This property is required. Changes to this property will trigger replacement.
- The name of the Kusto pool.
- Kusto
Pool Resource Id This property is required. string - The resource id of the kusto pool where the databases you would like to attach reside.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- Attached
Database Configuration Name Changes to this property will trigger replacement.
- The name of the attached database configuration.
- Location string
- Resource location.
- Table
Level TableSharing Properties Level Sharing Properties Args - Table level sharing specifications
- database
Name This property is required. String - 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 This property is required. String | DefaultPrincipals Modification Kind - The default principals modification kind
- kusto
Pool Name This property is required. Changes to this property will trigger replacement.
- The name of the Kusto pool.
- kusto
Pool Resource Id This property is required. String - The resource id of the kusto pool where the databases you would like to attach reside.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- attached
Database Configuration Name Changes to this property will trigger replacement.
- The name of the attached database configuration.
- location String
- Resource location.
- table
Level TableSharing Properties Level Sharing Properties - Table level sharing specifications
- database
Name This property is required. string - 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 This property is required. string | DefaultPrincipals Modification Kind - The default principals modification kind
- kusto
Pool Name This property is required. Changes to this property will trigger replacement.
- The name of the Kusto pool.
- kusto
Pool Resource Id This property is required. string - The resource id of the kusto pool where the databases you would like to attach reside.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- attached
Database Configuration Name Changes to this property will trigger replacement.
- The name of the attached database configuration.
- location string
- Resource location.
- table
Level TableSharing Properties Level Sharing Properties - Table level sharing specifications
- database_
name This property is required. 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 This property is required. str | DefaultPrincipals Modification Kind - The default principals modification kind
- kusto_
pool_ name This property is required. Changes to this property will trigger replacement.
- The name of the Kusto pool.
- kusto_
pool_ resource_ id This property is required. str - The resource id of the kusto pool where the databases you would like to attach reside.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace_
name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- attached_
database_ configuration_ name Changes to this property will trigger replacement.
- The name of the attached database configuration.
- location str
- Resource location.
- table_
level_ Tablesharing_ properties Level Sharing Properties Args - Table level sharing specifications
- database
Name This property is required. String - 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 This property is required. String | "Union" | "Replace" | "None" - The default principals modification kind
- kusto
Pool Name This property is required. Changes to this property will trigger replacement.
- The name of the Kusto pool.
- kusto
Pool Resource Id This property is required. String - The resource id of the kusto pool where the databases you would like to attach reside.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- attached
Database Configuration Name Changes to this property will trigger replacement.
- The name of the attached database configuration.
- location String
- Resource location.
- table
Level Property MapSharing Properties - Table level sharing specifications
Outputs
All input properties are implicitly available as output properties. Additionally, the KustoPoolAttachedDatabaseConfiguration resource produces the following output properties:
- Attached
Database List<string>Names - The list of databases from the clusterResourceId which are currently attached to the kusto pool.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - The provisioned state of the resource.
- System
Data Pulumi.Azure Native. Synapse. Outputs. System Data Response - 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"
- Attached
Database []stringNames - The list of databases from the clusterResourceId which are currently attached to the kusto pool.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - The provisioned state of the resource.
- System
Data SystemData Response - 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"
- attached
Database List<String>Names - The list of databases from the clusterResourceId which are currently attached to the kusto pool.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - The provisioned state of the resource.
- system
Data SystemData Response - 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"
- attached
Database string[]Names - The list of databases from the clusterResourceId which are currently attached to the kusto pool.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- provisioning
State string - The provisioned state of the resource.
- system
Data SystemData Response - 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"
- attached_
database_ Sequence[str]names - The list of databases from the clusterResourceId which are currently attached to the kusto pool.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- provisioning_
state str - The provisioned state of the resource.
- system_
data SystemData Response - 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"
- attached
Database List<String>Names - The list of databases from the clusterResourceId which are currently attached to the kusto pool.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - The provisioned state of the resource.
- system
Data 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"
Supporting Types
DefaultPrincipalsModificationKind, DefaultPrincipalsModificationKindArgs
- Union
- Union
- Replace
- Replace
- None
- None
- Default
Principals Modification Kind Union - Union
- Default
Principals Modification Kind Replace - Replace
- Default
Principals Modification Kind None - None
- Union
- Union
- Replace
- Replace
- None
- None
- Union
- Union
- Replace
- Replace
- None
- None
- UNION
- Union
- REPLACE
- Replace
- NONE
- None
- "Union"
- Union
- "Replace"
- Replace
- "None"
- None
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
TableLevelSharingProperties, TableLevelSharingPropertiesArgs
- External
Tables List<string>To Exclude - List of external tables exclude from the follower database
- External
Tables List<string>To Include - List of external tables to include in the follower database
- Materialized
Views List<string>To Exclude - List of materialized views exclude from the follower database
- Materialized
Views List<string>To Include - List of materialized views to include in the follower database
- Tables
To List<string>Exclude - List of tables to exclude from the follower database
- Tables
To List<string>Include - List of tables to include in the follower database
- External
Tables []stringTo Exclude - List of external tables exclude from the follower database
- External
Tables []stringTo Include - List of external tables to include in the follower database
- Materialized
Views []stringTo Exclude - List of materialized views exclude from the follower database
- Materialized
Views []stringTo Include - List of materialized views to include in the follower database
- Tables
To []stringExclude - List of tables to exclude from the follower database
- Tables
To []stringInclude - List of tables to include in the follower database
- external
Tables List<String>To Exclude - List of external tables exclude from the follower database
- external
Tables List<String>To Include - List of external tables to include in the follower database
- materialized
Views List<String>To Exclude - List of materialized views exclude from the follower database
- materialized
Views List<String>To Include - List of materialized views to include in the follower database
- tables
To List<String>Exclude - List of tables to exclude from the follower database
- tables
To List<String>Include - List of tables to include in the follower database
- external
Tables string[]To Exclude - List of external tables exclude from the follower database
- external
Tables string[]To Include - List of external tables to include in the follower database
- materialized
Views string[]To Exclude - List of materialized views exclude from the follower database
- materialized
Views string[]To Include - List of materialized views to include in the follower database
- tables
To string[]Exclude - List of tables to exclude from the follower database
- tables
To string[]Include - List of tables to include in the follower database
- external_
tables_ Sequence[str]to_ exclude - List of external tables exclude from the follower database
- external_
tables_ Sequence[str]to_ include - List of external tables to include in the follower database
- materialized_
views_ Sequence[str]to_ exclude - List of materialized views exclude from the follower database
- materialized_
views_ Sequence[str]to_ include - List of materialized views to include in the follower database
- tables_
to_ Sequence[str]exclude - List of tables to exclude from the follower database
- tables_
to_ Sequence[str]include - List of tables to include in the follower database
- external
Tables List<String>To Exclude - List of external tables exclude from the follower database
- external
Tables List<String>To Include - List of external tables to include in the follower database
- materialized
Views List<String>To Exclude - List of materialized views exclude from the follower database
- materialized
Views List<String>To Include - List of materialized views to include in the follower database
- tables
To List<String>Exclude - List of tables to exclude from the follower database
- tables
To List<String>Include - List of tables to include in the follower database
TableLevelSharingPropertiesResponse, TableLevelSharingPropertiesResponseArgs
- External
Tables List<string>To Exclude - List of external tables exclude from the follower database
- External
Tables List<string>To Include - List of external tables to include in the follower database
- Materialized
Views List<string>To Exclude - List of materialized views exclude from the follower database
- Materialized
Views List<string>To Include - List of materialized views to include in the follower database
- Tables
To List<string>Exclude - List of tables to exclude from the follower database
- Tables
To List<string>Include - List of tables to include in the follower database
- External
Tables []stringTo Exclude - List of external tables exclude from the follower database
- External
Tables []stringTo Include - List of external tables to include in the follower database
- Materialized
Views []stringTo Exclude - List of materialized views exclude from the follower database
- Materialized
Views []stringTo Include - List of materialized views to include in the follower database
- Tables
To []stringExclude - List of tables to exclude from the follower database
- Tables
To []stringInclude - List of tables to include in the follower database
- external
Tables List<String>To Exclude - List of external tables exclude from the follower database
- external
Tables List<String>To Include - List of external tables to include in the follower database
- materialized
Views List<String>To Exclude - List of materialized views exclude from the follower database
- materialized
Views List<String>To Include - List of materialized views to include in the follower database
- tables
To List<String>Exclude - List of tables to exclude from the follower database
- tables
To List<String>Include - List of tables to include in the follower database
- external
Tables string[]To Exclude - List of external tables exclude from the follower database
- external
Tables string[]To Include - List of external tables to include in the follower database
- materialized
Views string[]To Exclude - List of materialized views exclude from the follower database
- materialized
Views string[]To Include - List of materialized views to include in the follower database
- tables
To string[]Exclude - List of tables to exclude from the follower database
- tables
To string[]Include - List of tables to include in the follower database
- external_
tables_ Sequence[str]to_ exclude - List of external tables exclude from the follower database
- external_
tables_ Sequence[str]to_ include - List of external tables to include in the follower database
- materialized_
views_ Sequence[str]to_ exclude - List of materialized views exclude from the follower database
- materialized_
views_ Sequence[str]to_ include - List of materialized views to include in the follower database
- tables_
to_ Sequence[str]exclude - List of tables to exclude from the follower database
- tables_
to_ Sequence[str]include - List of tables to include in the follower database
- external
Tables List<String>To Exclude - List of external tables exclude from the follower database
- external
Tables List<String>To Include - List of external tables to include in the follower database
- materialized
Views List<String>To Exclude - List of materialized views exclude from the follower database
- materialized
Views List<String>To Include - List of materialized views to include in the follower database
- tables
To List<String>Exclude - List of tables to exclude from the follower database
- tables
To List<String>Include - List of tables to include in the follower database
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:synapse:KustoPoolAttachedDatabaseConfiguration KustoClusterRPTest4/attachedDatabaseConfigurations1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/attachedDatabaseConfigurations/{attachedDatabaseConfigurationName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0