kusto library
Azure Resource Manager kusto resources.
Classes
-
AppConstant<
T> -
A value the Stack hands to application code as a
static constin the generated AppExports file — known when synth runs, so the app compiles against it. - AppExports
-
Where synth writes the Dart file application code imports: the Stack's
constants, as the
static constmembers of<name>Constants, and a typed reader of its Terraform outputs,<name>Outputs. -
AttributeRef<
T> -
Public for sealed pattern matching, but constructor is private — only
TfRef.attribute()may construct instances. - AzurermBackend
-
terraform { backend "azurerm" { ... } }configuration. - AzurermKustoAttachedDatabaseConfiguration
-
Factory wrapper for
azurerm_kusto_attached_database_configuration. - AzurermKustoCluster
-
Factory wrapper for
azurerm_kusto_cluster. - AzurermKustoClusterCustomerManagedKey
-
Factory wrapper for
azurerm_kusto_cluster_customer_managed_key. - AzurermKustoClusterManagedPrivateEndpoint
-
Factory wrapper for
azurerm_kusto_cluster_managed_private_endpoint. - AzurermKustoClusterPrincipalAssignment
-
Factory wrapper for
azurerm_kusto_cluster_principal_assignment. - AzurermKustoCosmosdbDataConnection
-
Factory wrapper for
azurerm_kusto_cosmosdb_data_connection. - AzurermKustoDatabase
-
Factory wrapper for
azurerm_kusto_database. - AzurermKustoDatabasePrincipalAssignment
-
Factory wrapper for
azurerm_kusto_database_principal_assignment. - AzurermKustoEventgridDataConnection
-
Factory wrapper for
azurerm_kusto_eventgrid_data_connection. - AzurermKustoEventhubDataConnection
-
Factory wrapper for
azurerm_kusto_eventhub_data_connection. - AzurermKustoIothubDataConnection
-
Factory wrapper for
azurerm_kusto_iothub_data_connection. - AzurermKustoScript
-
Factory wrapper for
azurerm_kusto_script. - DartDefineOutput
-
An
outputwhose value is the client build's--dart-definefile, registered withStack.addDartDefineOutput. - Data
-
Base of every user-instantiable Terraform
datablock. - DataAzurermKustoCluster
-
Factory wrapper for
azurerm_kusto_cluster. - DataAzurermKustoDatabase
-
Factory wrapper for
azurerm_kusto_database. -
DataRef<
T> -
Public for sealed pattern matching, but constructor is private — only
TfRef.data()may construct instances. - EnvironmentConstant
- The AppConstant.fromEnvironment choice.
- GcsBackend
-
terraform { backend "gcs" { ... } }configuration. - IgnoreAllChanges
- IgnoreChanges.all.
- IgnoreAttributes
- IgnoreChanges.of.
- IgnoreChanges
-
What
ignore_changescovers: every attribute, or the listed ones. - InvalidDartDefineOutput
-
An output of
Stack.addDartDefineOutputthat cannot carry what it names: an output that is not registered, is sensitive or has no environment value, two outputs read from one variable, or no output at all. - InvalidLifecycle
-
A
lifecycleblock Terraform rejects: a data source (or one of its attributes) inreplaceTriggeredBy,allinside IgnoreChanges.of, or a condition with an empty error message. - InvalidMoveTarget
-
A
movedblock whosetonames no resource of the Stack. - InvalidTimeout
-
A negative
timeoutsduration. - KustoAttachedDatabaseConfigurationDatabaseNaming
-
At most one of
database_name_override,database_name_prefixonazurerm_kusto_attached_database_configuration: the provider rejects more than one, so each variant sets one of them and a null choice sets none. - KustoAttachedDatabaseConfigurationDatabaseNamingDatabaseNameOverride
-
The KustoAttachedDatabaseConfigurationDatabaseNaming.databaseNameOverride choice: sets
database_name_override. - KustoAttachedDatabaseConfigurationDatabaseNamingDatabaseNamePrefix
-
The KustoAttachedDatabaseConfigurationDatabaseNaming.databaseNamePrefix choice: sets
database_name_prefix. - KustoAttachedDatabaseConfigurationSharing
-
Typed helper for the
sharingblock ofazurerm_kusto_attached_database_configuration(derived from provider schema). - KustoClusterCustomerManagedKeyIdentifier
-
Exactly one of
key_vault_id,managed_hsm_key_idonazurerm_kusto_cluster_customer_managed_key: the provider rejects none and more than one, so each variant sets one of them. - KustoClusterCustomerManagedKeyIdentifierKeyVaultId
-
The KustoClusterCustomerManagedKeyIdentifier.keyVaultId choice: sets
key_vault_id. - KustoClusterCustomerManagedKeyIdentifierManagedHsmKeyId
-
The KustoClusterCustomerManagedKeyIdentifier.managedHsmKeyId choice: sets
managed_hsm_key_id. - KustoClusterIdentity
-
Typed helper for the
identityblock ofazurerm_kusto_cluster(derived from provider schema). - KustoClusterLanguageExtension
-
Typed helper for the
language_extensionblock ofazurerm_kusto_cluster(derived from provider schema). - KustoClusterOptimizedAutoScale
-
Typed helper for the
optimized_auto_scaleblock ofazurerm_kusto_cluster(derived from provider schema). - KustoClusterSku
-
Typed helper for the
skublock ofazurerm_kusto_cluster(derived from provider schema). - KustoScriptContent
-
Exactly one of
script_content,urlonazurerm_kusto_script: the provider rejects none and more than one, so each variant sets one of them. - KustoScriptContentChoice
-
The KustoScriptContent.scriptContent choice: sets
script_content. - KustoScriptContentUrl
-
The KustoScriptContent.url choice: sets
url. - LifecycleCondition
-
A
preconditionorpostconditionblock: Terraform fails the plan (LifecycleCondition.pre) or the apply (LifecycleCondition.post) with errorMessage when condition is false. - LifecycleOptions
-
lifecycle { ... }block on a resource. - LocalBackend
-
terraform { backend "local" { ... } }configuration. - MissingProvider
-
A block needs a provider configuration the Stack does not register:
the provider its type implies (
googleforgoogle_pubsub_topic), the one itsprovidermeta-argument names, or one a module call passes on. - ModuleCall
-
A
module "<localName>" { ... }call as a Dart value. - NoProviders
- The Stack registers no provider, but declares resources or data sources.
- ProviderConflict
- Two provider registrations Terraform rejects together: two defaults of one name, a repeated alias, an alias that is not an identifier, or configurations of one name with different source / version constraints.
-
RefConstant<
T> - The AppConstant.ref choice.
- ReplaceTrigger
-
What
lifecycle.replaceTriggeredBylists: a resource of the Stack or an attribute getter of one.Resourceand TfRef implement it; synth reports a data source or a data-source attribute as anInvalidLifecycle. - Resource
- Base of every user-instantiable Terraform resource.
- ResourceRef
-
Public for sealed pattern matching, but constructor is private — only
TfRef.resource()may construct instances. - S3Backend
-
terraform { backend "s3" { ... } }configuration. -
Sensitive<
T> -
What an argument Terraform marks sensitive takes: a variable, an
expression or an attribute getter — a value Terraform resolves, never a
Dart literal that would be written into
main.tf.json. - SensitiveLiteral
-
A sensitive field is set to a literal, which would write the secret in
plain text into
main.tf.json. - Stack
- User-extended IaC composition root.
- StackBackend
-
Lightweight backend hook. Core ships
GcsBackend,S3Backend,AzurermBackend, andLocalBackend; anything else implements this interface in the caller. TheStackonly stores the value and exposes a discriminator for synth'sterraform { backend ... }emitter. - StackProvider
-
Coordination interface between
Stack(in this package) and concrete providers (e.g.GoogleProviderinterradart_google). Concrete providers implement every getter using their baked-in constants from Stage 2 codegen. - SynthIssue
- One reason a Stack cannot be synthesized.
- SynthResult
- Bundle returned by Stack.synth.
- TfAddressed
-
Anything that exposes a Terraform address, e.g.
google_pubsub_topic.orders. -
TfArg<
T> - A Terraform argument: a Dart-side literal, a reference to another block's attribute (TfRef), a variable or a raw expression.
-
TfArgExpression<
T> - A raw Terraform expression — the tf.json template string, verbatim.
-
TfArgLiteral<
T> -
TfArgVariable<
T> - TfCollectionType
-
list(...),set(...)ormap(...). - TfMoved
-
One
moved { from = ... to = ... }block: the state object at from now belongs to the resource at to, so a rename does not become a destroy-and-create. - TfObjectType
-
object({ ... }). - TfOptionalType
-
optional(<type>[, <default>]). -
TfOutput<
T> -
An
output "<name>" { value = ... }block, registered withStack.addOutput. - TfPrimitiveType
-
string,number,boolorany. -
TfRef<
T> - A Terraform-side reference: an attribute of a resource (AttributeRef) or a data source (DataRef), or a whole resource (ResourceRef).
- TfTimeouts
-
timeouts { ... }on a resource or data source: how long Terraform waits for each operation before giving up. - TfTupleType
-
tuple([...]). - TfType
-
A Terraform type constraint:
string,list(number),object({ name = string }). - TfVariable
-
One
variable "<name>" { ... }declaration. - UndeclaredVariable
-
A
TfArg.variableorvar.<name>in an expression names a variable the Stack does not declare. - UnregisteredReference
-
A block references another block that was never registered on the
Stack: built, but not passed to
add(...)/addModule(...). - UnresolvableConstant
-
An
AppConstant.refwhose value is not known at synth: the attribute is not set to a literal, is sensitive, does not match the constant's type, or belongs to a block that is not registered. -
ValueConstant<
T> - The AppConstant.value choice.
Enums
- ResourceKind
-
Whether a Stack entry is a
resourceblock or adatablock in Terraform JSON.
Extension Types
- KustoAttachedDatabaseConfigurationDefaultPrincipalModificationKind
-
Kusto Attached Database Configuration Default Principal Modification enum for
default_principal_modification_kind. - KustoClusterImage
-
image— derived from the provider schema description. - KustoClusterLanguageExtensionName
-
name— derived from the provider schema description. - KustoClusterPrincipalAssignmentPrincipalType
-
Kusto Cluster Principal Assignment Principal enum for
principal_type. - KustoClusterPrincipalAssignmentRole
-
Kusto Cluster Principal Assignment enum for
role. - KustoClusterPublicIpType
-
Kusto Cluster Public Ip enum for
public_ip_type. - KustoClusterSkuName
-
name— derived from the provider schema description. - KustoDatabasePrincipalAssignmentPrincipalType
-
Kusto Database Principal Assignment Principal enum for
principal_type. - KustoDatabasePrincipalAssignmentRole
-
Kusto Database Principal Assignment enum for
role. - KustoEventgridDataConnectionBlobStorageEventType
-
Kusto Eventgrid Data Connection Blob Storage Event enum for
blob_storage_event_type. - KustoEventgridDataConnectionDatabaseRoutingType
-
Kusto Eventgrid Data Connection Database Routing enum for
database_routing_type. - KustoEventgridDataConnectionDataFormat
-
Kusto Eventgrid Data Connection Data enum for
data_format. - KustoEventhubDataConnectionCompression
-
Kusto Eventhub Data Connection enum for
compression. - KustoEventhubDataConnectionDatabaseRoutingType
-
Kusto Eventhub Data Connection Database Routing enum for
database_routing_type. - KustoEventhubDataConnectionDataFormat
-
Kusto Eventhub Data Connection Data enum for
data_format. - KustoIothubDataConnectionDatabaseRoutingType
-
Kusto Iothub Data Connection Database Routing enum for
database_routing_type. - KustoIothubDataConnectionDataFormat
-
Kusto Iothub Data Connection Data enum for
data_format. - KustoScriptLevel
-
Kusto Script enum for
script_level. - KustoScriptPrincipalPermissionsAction
-
Kusto Script Principal Permissions enum for
principal_permissions_action. - OutputEnvironment
-
The environment
Stack.outputEnvironmentreturns: each variable and its value, in registration order. - RefTo
-
A reference to a resource of type
R, for an argument that names another resource (network,vpc_id,role_arn, ...).
Extensions
-
RefToList
on TfArg<
List< RefTo< >R> > -
A list-valued reference argument (
security_group_ids,subnet_ids): a literal list of RefTos, or one value that is the whole list (TfArg.variable('subnet_ids'),TfArg.expression(...)). - TerraformDurationExt on Duration
- Converts a Dart Duration into a Terraform duration string ("604800s").
Constants
- terradartManifestVariable → const String
-
The environment variable the
terradartcommand sets to the file runStack and runEnvironments describe what they wrote in.
Functions
-
runEnvironments<
E extends Enum> (List< String> args, List<E> environments, Stack build(E env), {String dir(E env)?, String? workspace(E env)?, List<String> backendConfig(E env)?, E? defaultEnv}) → Future<void> -
The entry point of a project with one Stack per environment. The
environments are the members of an enum of the project's own — any
names, each carrying its values — so the Stack takes a typed
envand derives everything per environment from it, its backend included: -
runStack(
List< String> args, Stack build(), {String out = 'tf-out'}) → Future<void> -
The entry point of a project with one Stack: writes it to
out.
Typedefs
Exceptions / Errors
- DuplicateModuleError
-
A
ModuleCallregistered twice under one name. - DuplicateResourceError
-
Thrown by
Stack.addwhen an entry with the same(kind, terraformType, localName)triple is registered twice. - SynthException
-
Thrown by
Stack.synth()andStack.writeTo()when the Stack has one or more SynthIssues. Nothing is written.