Aspire.Hosting.Foundry
Official
📦 Aspire.Hosting.Foundry v13.2.0-preview.1.26170.3 94 Functions
41 Types
41 types and 99 members
Types
handle
AzureApplicationInsightsResource 1 members handle
AzureBicepResource 9 members handle
AzureBlobStorageContainerResource handle
AzureBlobStorageResource handle
AzureCognitiveServicesProjectConnectionResource handle
AzureCognitiveServicesProjectResource 10 members handle
AzureContainerRegistryResource 1 members handle
AzureCosmosDBContainerResource handle
AzureCosmosDBDatabaseResource 2 members handle
AzureCosmosDBEmulatorResource 4 members handle
AzureCosmosDBResource 6 members handle
AzureDataLakeStorageFileSystemResource handle
AzureDataLakeStorageResource handle
AzureEnvironmentResource 2 members handle
AzureKeyVaultResource 5 members handle
AzureKeyVaultSecretResource handle
AzureLogAnalyticsWorkspaceResource handle
AzurePromptAgentResource handle
AzureProvisioningResource 1 members handle
AzureQueueStorageQueueResource handle
AzureQueueStorageResource handle
AzureResourceInfrastructure 3 members handle
AzureSearchResource handle
AzureStorageEmulatorResource 6 members handle
AzureStorageResource 8 members handle
AzureTableStorageResource handle
AzureUserAssignedIdentityResource handle
BicepOutputReference 3 members handle
FoundryDeploymentResource 15 members type
FoundryModel 3 fields handle
FoundryResource 4 members handle
HostedAgentConfiguration 10 members interface
IAzureKeyVaultResource interface
IAzureKeyVaultSecretReference interface
IAzureResource 9 members Functions
function
addAndPublishPromptAgent builder Adds and publishes a prompt agent to a Microsoft Foundry project.
addAndPublishPromptAgent(model: FoundryDeploymentResource, name: string, instructions: string): AzurePromptAgentResource function
addAzureApplicationInsights builder Adds an Azure Application Insights resource
addAzureApplicationInsights(name: string): AzureApplicationInsightsResource function
addAzureContainerRegistry builder Adds an Azure Container Registry resource to the distributed application model.
addAzureContainerRegistry(name: string): AzureContainerRegistryResource function
addAzureCosmosDB builder Adds an Azure Cosmos DB resource
addAzureCosmosDB(name: string): AzureCosmosDBResource function
addAzureEnvironment builder Adds the shared Azure environment resource to the application model
addAzureEnvironment(): AzureEnvironmentResource function
addAzureInfrastructure builder Adds an Azure provisioning resource to the application model
addAzureInfrastructure(name: string, configureInfrastructure: (obj: AzureResourceInfrastructure) => void): AzureProvisioningResource function
addAzureKeyVault builder Adds an Azure Key Vault resource
addAzureKeyVault(name: string): AzureKeyVaultResource function
addAzureLogAnalyticsWorkspace builder Adds an Azure Log Analytics Workspace resource
addAzureLogAnalyticsWorkspace(name: string): AzureLogAnalyticsWorkspaceResource function
addAzureProvisioning Adds Azure provisioning services to the distributed application builder
addAzureProvisioning(): IDistributedApplicationBuilder function
addAzureSearch builder Adds an Azure AI Search service resource
addAzureSearch(name: string): AzureSearchResource function
addAzureStorage builder Adds an Azure Storage resource
addAzureStorage(name: string): AzureStorageResource function
addAzureUserAssignedIdentity builder Adds an Azure user-assigned identity resource
addAzureUserAssignedIdentity(name: string): AzureUserAssignedIdentityResource function
addBicepTemplate builder Adds an Azure Bicep template resource from a file
addBicepTemplate(name: string, bicepFile: string): AzureBicepResource function
addBicepTemplateString builder Adds an Azure Bicep template resource from inline Bicep content
addBicepTemplateString(name: string, bicepContent: string): AzureBicepResource function
addBlobContainer builder Adds an Azure Blob Storage container resource
addBlobContainer(name: string, blobContainerName?: string): AzureBlobStorageContainerResource function
addBlobs builder Adds an Azure Blob Storage resource
addBlobs(name: string): AzureBlobStorageResource function
addContainer builder Adds an Azure Cosmos DB container resource
addContainer(name: string, partitionKeyPath: string, containerName?: string): AzureCosmosDBContainerResource function
addContainerRegistryConnection builder Adds an Azure Container Registry connection to a Microsoft Foundry project.
addContainerRegistryConnection(registry: AzureContainerRegistryResource): AzureCognitiveServicesProjectConnectionResource function
addContainerWithPartitionKeyPaths builder Adds an Azure Cosmos DB container resource with hierarchical partition keys
addContainerWithPartitionKeyPaths(name: string, partitionKeyPaths: string[], containerName?: string): AzureCosmosDBContainerResource function
addCosmosConnection builder Adds an Azure Cosmos DB connection to a Microsoft Foundry project.
addCosmosConnection(db: AzureCosmosDBResource): AzureCognitiveServicesProjectConnectionResource function
addCosmosDatabase builder Adds an Azure Cosmos DB database resource
addCosmosDatabase(name: string, databaseName?: string): AzureCosmosDBDatabaseResource function
addDataLake builder Adds an Azure Data Lake Storage resource
addDataLake(name: string): AzureDataLakeStorageResource function
addDataLakeFileSystem builder Adds an Azure Data Lake Storage file system resource
addDataLakeFileSystem(name: string, dataLakeFileSystemName?: string): AzureDataLakeStorageFileSystemResource function
addDeployment builder Adds a Microsoft Foundry deployment resource to a Microsoft Foundry resource.
addDeployment(name: string, modelName: string, modelVersion: string, format: string): FoundryDeploymentResource function
addDeploymentFromModel builder Adds a Microsoft Foundry deployment resource by using a Microsoft Foundry model descriptor.
addDeploymentFromModel(name: string, model: FoundryModel): FoundryDeploymentResource function
addFoundry builder Adds a Microsoft Foundry resource to the distributed application model.
addFoundry(name: string): FoundryResource function
addKeyVaultConnection builder Adds an Azure Key Vault connection to a Microsoft Foundry project.
addKeyVaultConnection(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectConnectionResource function
addModelDeployment builder Adds a model deployment to the parent Microsoft Foundry resource.
addModelDeployment(name: string, modelName: string, modelVersion: string, format: string): FoundryDeploymentResource function
addModelDeploymentFromModel builder Adds a model deployment to the parent Microsoft Foundry resource by using a model descriptor.
addModelDeploymentFromModel(name: string, model: FoundryModel): FoundryDeploymentResource function
addProject builder Adds a Microsoft Foundry project resource to a Microsoft Foundry resource.
addProject(name: string): AzureCognitiveServicesProjectResource function
addQueue builder Adds an Azure Storage queue resource
addQueue(name: string, queueName?: string): AzureQueueStorageQueueResource function
addQueues builder Adds an Azure Queue Storage resource
addQueues(name: string): AzureQueueStorageResource function
addSecret builder Adds a secret to the Azure Key Vault from a parameter resource
addSecret(name: string, parameterResource: ParameterResource): AzureKeyVaultSecretResource function
addSecretFromExpression builder Adds a secret to the Azure Key Vault from a reference expression
addSecretFromExpression(name: string, value: ReferenceExpression): AzureKeyVaultSecretResource function
addSecretWithName builder Adds a named secret to the Azure Key Vault from a parameter resource
addSecretWithName(name: string, secretName: string, parameterResource: ParameterResource): AzureKeyVaultSecretResource function
addSecretWithNameFromExpression builder Adds a named secret to the Azure Key Vault from a reference expression
addSecretWithNameFromExpression(name: string, secretName: string, value: ReferenceExpression): AzureKeyVaultSecretResource function
addStorageConnection builder Adds an Azure Storage connection to a Microsoft Foundry project.
addStorageConnection(storage: AzureStorageResource): AzureCognitiveServicesProjectConnectionResource function
addTables builder Adds an Azure Table Storage resource
addTables(name: string): AzureTableStorageResource function
asExisting builder Marks an Azure resource as existing in both run and publish modes by using parameter resources
asExisting(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
clearDefaultRoleAssignments builder Clears the default Azure role assignments from a resource
clearDefaultRoleAssignments(): IAzureResource function
configureInfrastructure builder Configures the Azure provisioning infrastructure callback
configureInfrastructure(configure: (obj: AzureResourceInfrastructure) => void): AzureProvisioningResource function
getAzureContainerRegistry builder Gets the Azure Container Registry associated with a compute environment resource.
getAzureContainerRegistry(): AzureContainerRegistryResource function
getBicepIdentifier Gets the normalized Bicep identifier for an Azure resource
getBicepIdentifier(): string function
getOutput Gets an output reference from an Azure Bicep template resource
getOutput(name: string): BicepOutputReference function
getSecret Gets a secret reference from the Azure Key Vault
getSecret(secretName: string): IAzureKeyVaultSecretReference function
isExisting Determines whether a resource is marked as existing
isExisting(): boolean function
publishAsConnectionString builder Publishes an Azure resource to the manifest as a connection string
publishAsConnectionString(): IAzureResource function
publishAsExisting builder Marks an Azure resource as existing in publish mode
publishAsExisting(name: string, resourceGroup: string): IAzureResource function
publishAsExistingFromParameters builder Marks an Azure resource as existing in publish mode by using parameter resources
publishAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
publishAsHostedAgent builder Publishes an executable resource as a hosted agent in Microsoft Foundry.
publishAsHostedAgent(project?: AzureCognitiveServicesProjectResource, configure?: (obj: HostedAgentConfiguration) => void): ExecutableResource function
runAsEmulator builder Configures the Azure Cosmos DB resource to run using the local emulator
runAsEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => void): AzureCosmosDBResource function
runAsEmulator builder Configures the Azure Storage resource to be emulated using Azurite
runAsEmulator(configureContainer?: (obj: AzureStorageEmulatorResource) => void): AzureStorageResource function
runAsExisting builder Marks an Azure resource as existing in run mode
runAsExisting(name: string, resourceGroup: string): IAzureResource function
runAsExistingFromParameters builder Marks an Azure resource as existing in run mode by using parameter resources
runAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
runAsFoundryLocal builder Configures the Microsoft Foundry resource to run by using Foundry Local.
runAsFoundryLocal(): FoundryResource function
runAsPreviewEmulator builder Configures the Azure Cosmos DB resource to run using the preview emulator
runAsPreviewEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => void): AzureCosmosDBResource function
withAccessKeyAuthentication builder Configures Azure Cosmos DB to use access key authentication
withAccessKeyAuthentication(): AzureCosmosDBResource function
withAccessKeyAuthenticationWithKeyVault builder Configures Azure Cosmos DB access key authentication using a specified Azure Key Vault resource
withAccessKeyAuthenticationWithKeyVault(keyVaultBuilder: IAzureKeyVaultResource): AzureCosmosDBResource function
withApiVersionCheck builder Configures whether the emulator checks API version validity
withApiVersionCheck(enable?: boolean): AzureStorageEmulatorResource function
withAppInsights builder Associates an Azure Application Insights resource with a Microsoft Foundry project.
withAppInsights(appInsights: AzureApplicationInsightsResource): AzureCognitiveServicesProjectResource function
withAzureContainerRegistry builder Configures a compute environment resource to use an Azure Container Registry.
withAzureContainerRegistry(registryBuilder: AzureContainerRegistryResource): IResource function
withAzureUserAssignedIdentity builder Associates an Azure user-assigned identity with a compute resource
withAzureUserAssignedIdentity(identityResourceBuilder: AzureUserAssignedIdentityResource): IComputeResource function
withBlobPort builder Sets the host port for blob requests on the storage emulator
withBlobPort(port: number): AzureStorageEmulatorResource function
withContainerRegistry builder Associates a container registry with a Microsoft Foundry project resource.
withContainerRegistry(registryBuilder: AzureContainerRegistryResource): AzureCognitiveServicesProjectResource function
withContainerRegistryRoleAssignments builder Assigns Azure Container Registry roles to a resource.
withContainerRegistryRoleAssignments(target: AzureContainerRegistryResource, roles: AzureContainerRegistryRole[]): IResource function
withDataBindMount builder Adds a bind mount for the data folder to an Azure Storage emulator resource
withDataBindMount(path?: string, isReadOnly?: boolean): AzureStorageEmulatorResource function
withDataExplorer builder Exposes the Data Explorer endpoint for the preview emulator
withDataExplorer(port?: number): AzureCosmosDBEmulatorResource function
withDataVolume builder Adds a named volume for the data folder to an Azure Cosmos DB emulator resource
withDataVolume(name?: string): AzureCosmosDBEmulatorResource function
withDataVolume builder Adds a named volume for the data folder to an Azure Storage emulator resource
withDataVolume(name?: string, isReadOnly?: boolean): AzureStorageEmulatorResource function
withDefaultAzureSku builder Configures Azure Cosmos DB to use the default Azure SKU
withDefaultAzureSku(): AzureCosmosDBResource function
withEnvironmentFromKeyVaultSecret builder Sets an environment variable from an Azure Key Vault secret reference
withEnvironmentFromKeyVaultSecret(name: string, secretReference: IAzureKeyVaultSecretReference): IResourceWithEnvironment function
withEnvironmentFromOutput builder Sets an environment variable from a Bicep output reference
withEnvironmentFromOutput(name: string, bicepOutputReference: BicepOutputReference): IResourceWithEnvironment function
withGatewayPort builder Sets the host port for the Cosmos DB emulator gateway endpoint
withGatewayPort(port: number): AzureCosmosDBEmulatorResource function
withKeyVault builder Associates an Azure Key Vault resource with a Microsoft Foundry project.
withKeyVault(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectResource function
withKeyVaultRoleAssignments builder Assigns Key Vault roles to a resource
withKeyVaultRoleAssignments(target: AzureKeyVaultResource, roles: AzureKeyVaultRole[]): IResource function
withLocation builder Sets the Azure location for the shared Azure environment resource
withLocation(location: ParameterResource): AzureEnvironmentResource function
withLogAnalyticsWorkspace builder Configures the Application Insights resource to use a Log Analytics Workspace
withLogAnalyticsWorkspace(logAnalyticsWorkspace: AzureLogAnalyticsWorkspaceResource): AzureApplicationInsightsResource function
withParameter builder Adds a Bicep parameter without a value
withParameter(name: string): AzureBicepResource function
withParameterFromConnectionString builder Adds a Bicep parameter from a connection string resource builder
withParameterFromConnectionString(name: string, value: IResourceWithConnectionString): AzureBicepResource function
withParameterFromEndpoint builder Adds a Bicep parameter from an endpoint reference
withParameterFromEndpoint(name: string, value: EndpointReference): AzureBicepResource function
withParameterFromOutput builder Adds a Bicep parameter from another Bicep output reference
withParameterFromOutput(name: string, value: BicepOutputReference): AzureBicepResource function
withParameterFromParameter builder Adds a Bicep parameter from a parameter resource builder
withParameterFromParameter(name: string, value: ParameterResource): AzureBicepResource function
withParameterFromReferenceExpression builder Adds a Bicep parameter from a reference expression
withParameterFromReferenceExpression(name: string, value: ReferenceExpression): AzureBicepResource function
withParameterStringValue builder Adds a Bicep parameter with a string value
withParameterStringValue(name: string, value: string): AzureBicepResource function
withParameterStringValues builder Adds a Bicep parameter with a string list value
withParameterStringValues(name: string, value: string[]): AzureBicepResource function
withPartitionCount builder Sets the partition count for the Azure Cosmos DB emulator
withPartitionCount(count: number): AzureCosmosDBEmulatorResource function
withProperties builder Configures properties of a Microsoft Foundry deployment resource.
withProperties(configure: (obj: FoundryDeploymentResource) => void): FoundryDeploymentResource function
withPurgeTask builder Configures a purge task for the Azure Container Registry resource.
withPurgeTask(schedule: string, filter?: string, ago?: timespan, keep?: number, taskName?: string): AzureContainerRegistryResource function
withQueuePort builder Sets the host port for queue requests on the storage emulator
withQueuePort(port: number): AzureStorageEmulatorResource function
withResourceGroup builder Sets the Azure resource group for the shared Azure environment resource
withResourceGroup(resourceGroup: ParameterResource): AzureEnvironmentResource function
withRoleAssignments builder Assigns Microsoft Foundry roles to a resource
withRoleAssignments(target: FoundryResource, roles: FoundryRole[]): IResource function
withSearchRoleAssignments builder Assigns Azure AI Search roles to a resource
withSearchRoleAssignments(target: AzureSearchResource, roles: AzureSearchRole[]): IResource function
withStorageRoleAssignments builder Assigns Azure Storage roles to a resource
withStorageRoleAssignments(target: AzureStorageResource, roles: AzureStorageRole[]): IResource function
withTablePort builder Sets the host port for table requests on the storage emulator
withTablePort(port: number): AzureStorageEmulatorResource