Skip to content
Docs Try Aspire

Aspire.Hosting.Azure.Kusto

Official
📦 Aspire.Hosting.Azure.Kusto v13.2.0-preview.1.26159.1 TypeScript
166 Functions
75 Types

Types

handle AzureBicepResource 9 members
handle AzureEnvironmentResource 2 members
handle AzureKustoClusterResource 9 members
handle AzureKustoEmulatorResource 1 members
handle AzureKustoReadWriteDatabaseResource 5 members
handle AzureProvisioningResource 1 members
handle AzureResourceInfrastructure 3 members
handle AzureUserAssignedIdentityResource
handle BicepOutputReference 3 members
handle CancellationToken
handle CommandLineArgsCallbackContext 4 members
type CommandOptions 7 fields
handle ConnectionStringResource
handle ContainerRegistryResource
handle ContainerResource 18 members
type CreateBuilderOptions 8 fields
handle CSharpAppResource
handle DistributedApplication 1 members
handle DistributedApplicationEventSubscription
handle DistributedApplicationExecutionContext 5 members
handle DistributedApplicationExecutionContextOptions
handle DistributedApplicationResourceEventSubscription
handle DotnetToolResource 6 members
handle EndpointReference 13 members
handle EndpointReferenceExpression 3 members
handle EnvironmentCallbackContext 3 members
handle ExecutableResource 4 members
handle ExecuteCommandContext 4 members
type ExecuteCommandResult 3 fields
handle ExternalServiceResource 1 members
interface IAzureKeyVaultResource
interface IAzureKeyVaultSecretReference
interface IAzureResource 9 members
interface IConfiguration 2 members
interface IDistributedApplicationBuilder 25 members
interface IDistributedApplicationEvent
interface IDistributedApplicationEventing 1 members
interface IDistributedApplicationResourceEvent
interface IHostEnvironment 2 members
interface IResource 22 members
interface IResourceWithArgs 3 members
interface IResourceWithConnectionString 2 members
interface IResourceWithContainerFiles 2 members
interface IResourceWithEndpoints 10 members
interface IResourceWithEnvironment 21 members
interface IResourceWithParent
interface IResourceWithServiceDiscovery
interface IResourceWithWaitSupport 5 members
interface IServiceProvider 2 members
handle ParameterResource 1 members
handle PipelineConfigurationContext 3 members
handle PipelineStep 12 members
handle PipelineStepContext 2 members
handle ProjectResource 2 members
handle ProjectResourceOptions 6 members
handle ReferenceExpression
handle ReferenceExpressionBuilder 5 members
type ResourceEventDto 6 fields
handle ResourceLoggerService 2 members
handle ResourceNotificationService 6 members
type ResourceUrlAnnotation 4 fields
handle ResourceUrlsCallbackContext 3 members
handle UpdateCommandStateContext

Functions

function addAzureEnvironment builder
Adds the shared Azure environment resource to the application model
function addAzureInfrastructure builder
Adds an Azure provisioning resource to the application model
function addAzureKustoCluster builder
Adds an Azure Data Explorer (Kusto) cluster resource
function addAzureProvisioning
Adds Azure provisioning services to the distributed application builder
function addAzureUserAssignedIdentity builder
Adds an Azure user-assigned identity resource
function addBicepTemplate builder
Adds an Azure Bicep template resource from a file
function addBicepTemplateString builder
Adds an Azure Bicep template resource from inline Bicep content
function addConnectionString builder
Adds a connection string resource
function addConnectionStringBuilder builder
Adds a connection string with a builder callback
function addContainer builder
Adds a container resource
function addContainerRegistry builder
Adds a container registry resource
function addCSharpApp builder
Adds a C# application resource
function addCSharpAppWithOptions builder
Adds a C# application resource with configuration options
function addDockerfile builder
Adds a container resource built from a Dockerfile
function addDotnetTool builder
Adds a .NET tool resource
function addExecutable builder
Adds an executable resource
function addExternalService builder
Adds an external service resource
function addParameter builder
Adds a parameter resource
function addParameterFromConfiguration builder
Adds a parameter sourced from configuration
function addProject builder
Adds a .NET project resource
function addProjectWithOptions builder
Adds a project resource with configuration options
function addReadWriteDatabase builder
Adds a Kusto read-write database resource
function asExisting builder
Marks an Azure resource as existing in both run and publish modes
function asHttp2Service builder
Configures resource for HTTP/2
function clearContainerFilesSources builder
Clears all container file sources
function clearDefaultRoleAssignments builder
Clears the default Azure role assignments from a resource
function completeLog
Completes the log stream for a resource
function completeLogByName
Completes the log stream by resource name
function configureInfrastructure builder
Configures the Azure provisioning infrastructure callback
function createBuilder
Creates a new distributed application builder
function createBuilderWithOptions
Creates builder with options
function disableForwardedHeaders builder
Disables forwarded headers for the project
function excludeFromManifest builder
Excludes the resource from the deployment manifest
function excludeFromMcp builder
Excludes the resource from MCP server exposure
function getBicepIdentifier
Gets the normalized Bicep identifier for an Azure resource
function getConfigValue
Gets a configuration value by key
function getConnectionString
Gets a connection string by name
function getEndpoint
Gets an endpoint reference
function getEnvironmentName
Gets the environment name
function getOutput
Gets an output reference from an Azure Bicep template resource
function getRequiredService
Gets a required service by ATS type ID
function getResourceName
Gets the resource name
function getService
Gets a service by ATS type ID
function isDevelopment
Checks if running in Development environment
function isExisting
Determines whether a resource is marked as existing
function log
Logs a message with specified level
function logDebug
Logs a debug message
function logError
Logs an error message
function logInformation
Logs an information message
function logWarning
Logs a warning message
function publishAsConnectionString builder
Publishes the resource as a connection string
function publishAsConnectionString builder
Publishes an Azure resource to the manifest as a connection string
function publishAsContainer builder
Configures the resource to be published as a container
function publishAsDockerFile builder
Publishes the executable as a Docker container
function publishAsDockerFileWithConfigure builder
Publishes an executable as a Docker file with optional container configuration
function publishAsExisting builder
Marks an Azure resource as existing in publish mode
function publishAsExistingFromParameters builder
Marks an Azure resource as existing in publish mode by using parameter resources
function publishResourceUpdate
Publishes an update for a resource's state
function publishWithContainerFiles builder
Configures the resource to copy container files from the specified source during publishing
function runAsEmulator builder
Configures the Kusto cluster to run using the local emulator
function runAsExisting builder
Marks an Azure resource as existing in run mode
function runAsExistingFromParameters builder
Marks an Azure resource as existing in run mode by using parameter resources
function tryGetResourceState
Tries to get the current state of a resource
function waitFor builder
Waits for another resource to be ready
function waitForCompletion builder
Waits for resource completion
function waitForDependencies
Waits for all dependencies of a resource to be ready
function waitForResourceHealthy
Waits for a resource to become healthy
function waitForResourceState
Waits for a resource to reach a specified state
function waitForResourceStates
Waits for a resource to reach one of the specified states
function waitForStart builder
Waits for another resource to start
function waitForStartWithBehavior builder
Waits for another resource to start with specific behavior
function waitForWithBehavior builder
Waits for another resource with specific behavior
function withArgs builder
Adds arguments
function withArgsCallback builder
Sets command-line arguments via callback
function withArgsCallbackAsync builder
Sets command-line arguments via async callback
function withAzureUserAssignedIdentity builder
Associates an Azure user-assigned identity with a compute resource
function withBindMount builder
Adds a bind mount
function withBuildArg builder
Adds a build argument from a parameter resource
function withBuildSecret builder
Adds a build secret from a parameter resource
function withCertificateTrustScope builder
Sets the certificate trust scope
function withChildRelationship builder
Sets a child relationship
function withCommand builder
Adds a resource command
function withConnectionProperty builder
Adds a connection property with a reference expression
function withConnectionPropertyValue builder
Adds a connection property with a string value
function withContainerFilesSource builder
Sets the source directory for container files
function withContainerName builder
Sets the container name
function withContainerNetworkAlias builder
Adds a network alias for the container
function withContainerRegistry builder
Configures a resource to use a container registry
function withContainerRuntimeArgs builder
Adds runtime arguments for the container
function withCreationScript builder
Defines the KQL script used to create the database
function withDescription builder
Sets a parameter description
function withDeveloperCertificateTrust builder
Configures developer certificate trust
function withDockerfile builder
Configures the resource to use a Dockerfile
function withDockerfileBaseImage builder
Sets the base image for a Dockerfile build
function withEndpoint builder
Adds a network endpoint
function withEndpointProxySupport builder
Configures endpoint proxy support
function withEntrypoint builder
Sets the container entrypoint
function withEnvironment builder
Sets an environment variable
function withEnvironmentCallback builder
Sets environment variables via callback
function withEnvironmentCallbackAsync builder
Sets environment variables via async callback
function withEnvironmentConnectionString builder
Sets an environment variable from a connection string resource
function withEnvironmentEndpoint builder
Sets an environment variable from an endpoint reference
function withEnvironmentExpression builder
Adds an environment variable with a reference expression
function withEnvironmentFromKeyVaultSecret builder
Sets an environment variable from an Azure Key Vault secret reference
function withEnvironmentFromOutput builder
Sets an environment variable from a Bicep output reference
function withEnvironmentParameter builder
Sets an environment variable from a parameter resource
function withExecutableCommand builder
Sets the executable command
function withExplicitStart builder
Prevents resource from starting automatically
function withExternalHttpEndpoints builder
Makes HTTP endpoints externally accessible
function withExternalServiceHttpHealthCheck builder
Adds an HTTP health check to an external service
function withHealthCheck builder
Adds a health check by key
function withHostPort builder
Sets the host port for the Kusto emulator endpoint
function withHttpEndpoint builder
Adds an HTTP endpoint
function withHttpHealthCheck builder
Adds an HTTP health check
function withHttpProbe builder
Adds an HTTP health probe to the resource
function withHttpsDeveloperCertificate builder
Configures HTTPS with a developer certificate
function withHttpsEndpoint builder
Adds an HTTPS endpoint
function withIconName builder
Sets the icon for the resource
function withImage builder
Sets the container image
function withImagePullPolicy builder
Sets the container image pull policy
function withImageRegistry builder
Sets the container image registry
function withImageSHA256 builder
Sets the image SHA256 digest
function withImageTag builder
Sets the container image tag
function withLifetime builder
Sets the lifetime behavior of the container resource
function withLocation builder
Sets the Azure location for the shared Azure environment resource
function withMcpServer builder
Configures an MCP server endpoint on the resource
function withOtlpExporter builder
Configures OTLP telemetry export
function withOtlpExporterProtocol builder
Configures OTLP telemetry export with specific protocol
function withoutHttpsCertificate builder
Removes HTTPS certificate configuration
function withParameter builder
Adds a Bicep parameter without a value
function withParameterFromConnectionString builder
Adds a Bicep parameter from a connection string resource builder
function withParameterFromEndpoint builder
Adds a Bicep parameter from an endpoint reference
function withParameterFromOutput builder
Adds a Bicep parameter from another Bicep output reference
function withParameterFromParameter builder
Adds a Bicep parameter from a parameter resource builder
function withParameterFromReferenceExpression builder
Adds a Bicep parameter from a reference expression
function withParameterStringValue builder
Adds a Bicep parameter with a string value
function withParameterStringValues builder
Adds a Bicep parameter with a string list value
function withParentRelationship builder
Sets the parent relationship
function withPipelineConfiguration builder
Configures pipeline step dependencies via a callback
function withPipelineConfigurationAsync builder
Configures pipeline step dependencies via an async callback
function withPipelineStepFactory builder
Adds a pipeline step to the resource
function withReference builder
Adds a reference to another resource
function withReferenceEndpoint builder
Adds a reference to an endpoint
function withReferenceExternalService builder
Adds a reference to an external service
function withReferenceUri builder
Adds a reference to a URI
function withRemoteImageName builder
Sets the remote image name for publishing
function withRemoteImageTag builder
Sets the remote image tag for publishing
function withReplicas builder
Sets the number of replicas
function withRequiredCommand builder
Adds a required command dependency
function withResourceGroup builder
Sets the Azure resource group for the shared Azure environment resource
function withServiceReference builder
Adds a service discovery reference to another resource
function withServiceReferenceNamed builder
Adds a named service discovery reference
function withToolIgnoreExistingFeeds builder
Ignores existing NuGet feeds
function withToolIgnoreFailedSources builder
Ignores failed NuGet sources
function withToolPackage builder
Sets the tool package ID
function withToolPrerelease builder
Allows prerelease tool versions
function withToolSource builder
Adds a NuGet source for the tool
function withToolVersion builder
Sets the tool version
function withUrl builder
Adds or modifies displayed URLs
function withUrlExpression builder
Adds a URL using a reference expression
function withUrlForEndpoint builder
Customizes the URL for a specific endpoint via callback
function withUrlForEndpointFactory builder
Adds a URL for a specific endpoint via factory callback
function withUrlsCallback builder
Customizes displayed URLs via callback
function withUrlsCallbackAsync builder
Customizes displayed URLs via async callback
function withVolume builder
Adds a volume
function withWorkingDirectory builder
Sets the executable working directory

Enumerations