Versions in this module Expand all Collapse all v1 v1.23.14 Apr 4, 2026 Changes in this version type DockerProjectOptions + Network string v1.23.13 Mar 26, 2026 Changes in this version + const AiDeploymentEnvVarName + const AiEndpointEnvVarName + const AiEnvironmentEnvVarName + const AiFlowEnvVarName + const AiHubNameEnvVarName + const AiModelEnvVarName + const AiProjectNameEnvVarName + const AppServiceJavaPackageName + const DefaultBuilderImage + const DefaultStaticWebAppEnvironmentName + const MetadataKeyClickable + const MetadataKeyNote + const ProjectEventBuild + const ProjectEventDeploy + const ProjectEventPackage + const ProjectEventProvision + const ProjectEventPublish + const ProjectEventRestore + const ServiceEventBuild + const ServiceEventDeploy + const ServiceEventEnvUpdated + const ServiceEventPackage + const ServiceEventPublish + const ServiceEventRestore + var DefaultProvisioningOptions = provisioning.Options + var ErrNoDefaultService = errors.New("no default service selection matches the working directory") + var ProjectEvents []ext.Event = []ext.Event + var ServiceEvents []ext.Event = []ext.Event + func LoadConfig(ctx context.Context, projectFilePath string) (config.Config, error) + func OverriddenEndpoints(ctx context.Context, serviceConfig *ServiceConfig, ...) []string + func Save(ctx context.Context, projectConfig *ProjectConfig, projectFilePath string) error + func SaveConfig(ctx context.Context, config config.Config, projectFilePath string) error + type AIModelProps struct + Model AIModelPropsModel + type AIModelPropsModel struct + Name string + Version string + type AiFoundryModelProps struct + Models []AiServicesModel + type AiHelper interface + CreateEnvironmentVersion func(ctx context.Context, scope *ai.Scope, serviceConfig *ServiceConfig, ...) (*armmachinelearning.EnvironmentVersion, error) + CreateFlow func(ctx context.Context, scope *ai.Scope, serviceConfig *ServiceConfig, ...) (*ai.Flow, error) + CreateModelVersion func(ctx context.Context, scope *ai.Scope, serviceConfig *ServiceConfig, ...) (*armmachinelearning.ModelVersion, error) + DeleteDeployments func(ctx context.Context, scope *ai.Scope, endpointName string, filter []string) error + DeployToEndpoint func(ctx context.Context, scope *ai.Scope, serviceConfig *ServiceConfig, ...) (*armmachinelearning.OnlineDeployment, error) + GetEndpoint func(ctx context.Context, scope *ai.Scope, endpointName string) (*armmachinelearning.OnlineEndpoint, error) + Initialize func(ctx context.Context) error + RequiredExternalTools func(ctx context.Context) []tools.ExternalTool + UpdateTraffic func(ctx context.Context, scope *ai.Scope, endpointName string, ...) (*armmachinelearning.OnlineEndpoint, error) + ValidateWorkspace func(ctx context.Context, scope *ai.Scope) error + func NewAiHelper(env *environment.Environment, clock clock.Clock, pythonBridge ai.PythonBridge, ...) AiHelper + type AiServicesModel struct + Format string + Name string + Sku AiServicesModelSku + Version string + type AiServicesModelSku struct + Capacity int32 + Name string + UsageName string + type AksDeploymentOptions struct + Name string + type AksIngressOptions struct + Name string + RelativePath string + type AksOptions struct + Deployment AksDeploymentOptions + DeploymentPath string + Helm *helm.Config + Ingress AksIngressOptions + Kustomize *kustomize.Config + Namespace string + Service AksServiceOptions + type AksServiceOptions struct + Name string + type AppServiceProps struct + Env []ServiceEnvVar + Port int + Runtime AppServiceRuntime + StartupCommand string + type AppServiceRuntime struct + Stack AppServiceRuntimeStack + Version string + type AppServiceRuntimeStack string + const AppServiceRuntimeStackNode + const AppServiceRuntimeStackPython + type Artifact struct + Kind ArtifactKind + Location string + LocationKind LocationKind + Metadata map[string]string + func (a *Artifact) MarshalJSON() ([]byte, error) + func (a *Artifact) ToString(currentIndentation string) string + type ArtifactCollection []*Artifact + func (ac *ArtifactCollection) Add(artifacts ...*Artifact) error + func (ac ArtifactCollection) Find(opts ...FindOpts) []*Artifact + func (ac ArtifactCollection) FindFirst(opts ...FindOpts) (*Artifact, bool) + func (ac ArtifactCollection) FindLast(opts ...FindOpts) (*Artifact, bool) + func (ac ArtifactCollection) MarshalJSON() ([]byte, error) + func (ac ArtifactCollection) ToString(currentIndentation string) string + type ArtifactKind string + const ArtifactKindArchive + const ArtifactKindConfig + const ArtifactKindContainer + const ArtifactKindDeployment + const ArtifactKindDirectory + const ArtifactKindEndpoint + const ArtifactKindResource + type CompositeFrameworkService interface + SetSource func(inner FrameworkService) + func NewDockerProject(env *environment.Environment, docker *docker.Cli, ...) CompositeFrameworkService + func NewSwaProject(env *environment.Environment, console input.Console, ...) CompositeFrameworkService + type ConfigValidationError struct + Issues []string + func (e *ConfigValidationError) Error() string + type ContainerAppProps struct + Env []ServiceEnvVar + Port int + type ContainerFile struct + Destination string + ServiceConfig *ServiceConfig + Sources []string + type ContainerHelper struct + func NewContainerHelper(clock clock.Clock, containerRegistryService azapi.ContainerRegistryService, ...) *ContainerHelper + func (ch *ContainerHelper) Build(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServiceBuildResult, error) + func (ch *ContainerHelper) Credentials(ctx context.Context, serviceConfig *ServiceConfig, ...) (*azapi.DockerCredentials, error) + func (ch *ContainerHelper) DefaultImageName(ctx context.Context, serviceConfig *ServiceConfig, ...) (string, error) + func (ch *ContainerHelper) DefaultImageTag() string + func (ch *ContainerHelper) DockerfileBuilder() *DockerfileBuilder + func (ch *ContainerHelper) GeneratedImage(ctx context.Context, serviceConfig *ServiceConfig, ...) (*docker.ContainerImage, error) + func (ch *ContainerHelper) LocalImageTag(ctx context.Context, serviceConfig *ServiceConfig, ...) (string, error) + func (ch *ContainerHelper) Login(ctx context.Context, serviceConfig *ServiceConfig, ...) (string, error) + func (ch *ContainerHelper) Package(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServicePackageResult, error) + func (ch *ContainerHelper) Publish(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServicePublishResult, error) + func (ch *ContainerHelper) RegistryName(ctx context.Context, serviceConfig *ServiceConfig, ...) (string, error) + func (ch *ContainerHelper) RemoteImageTag(ctx context.Context, serviceConfig *ServiceConfig, localImageTag string, ...) (string, error) + func (ch *ContainerHelper) RemoveLocalImage(ctx context.Context, imageName string) error + func (ch *ContainerHelper) RequiredExternalTools(ctx context.Context, serviceConfig *ServiceConfig) []tools.ExternalTool + type CosmosDBContainerProps struct + Name string + PartitionKeys []string + type CosmosDBProps struct + Containers []CosmosDBContainerProps + type DockerProjectOptions struct + BuildArgs []osutil.ExpandableString + BuildEnv []string + BuildSecrets []string + Context string + Image osutil.ExpandableString + InMemDockerfile []byte + Path string + Platform string + Registry osutil.ExpandableString + RemoteBuild bool + Tag osutil.ExpandableString + Target string + type DockerfileBuilder struct + func NewDockerfileBuilder() *DockerfileBuilder + func (b *DockerfileBuilder) Arg(name string, defaultValue ...string) *DockerfileBuilder + func (b *DockerfileBuilder) Build(w io.Writer) error + func (b *DockerfileBuilder) From(image string, stageName ...string) *DockerfileStage + type DockerfileStage struct + func (s *DockerfileStage) Arg(name string, defaultValue ...string) *DockerfileStage + func (s *DockerfileStage) Cmd(command ...string) *DockerfileStage + func (s *DockerfileStage) Comment(comment string) *DockerfileStage + func (s *DockerfileStage) Copy(source, destination string, chown ...string) *DockerfileStage + func (s *DockerfileStage) CopyFrom(from, source, destination string, chown ...string) *DockerfileStage + func (s *DockerfileStage) EmptyLine() *DockerfileStage + func (s *DockerfileStage) Entrypoint(command ...string) *DockerfileStage + func (s *DockerfileStage) Env(name, value string) *DockerfileStage + func (s *DockerfileStage) Expose(port int) *DockerfileStage + func (s *DockerfileStage) Run(command string) *DockerfileStage + func (s *DockerfileStage) RunWithMounts(command string, mounts ...string) *DockerfileStage + func (s *DockerfileStage) User(user string) *DockerfileStage + func (s *DockerfileStage) WorkDir(path string) *DockerfileStage + type DotNetContainerAppOptions struct + AppHostPath string + ContainerFiles map[string]ContainerFile + ContainerImage string + Manifest *apphost.Manifest + ProjectName string + type DotNetImporter struct + func NewDotNetImporter(dotnetCli *dotnet.Cli, console input.Console, ...) *DotNetImporter + func (ai *DotNetImporter) CanImport(ctx context.Context, projectPath string) (bool, error) + func (ai *DotNetImporter) GenerateAllInfrastructure(ctx context.Context, p *ProjectConfig, svcConfig *ServiceConfig) (fs.FS, error) + func (ai *DotNetImporter) ProjectInfrastructure(ctx context.Context, svcConfig *ServiceConfig) (*Infra, error) + func (ai *DotNetImporter) ReadManifest(ctx context.Context, svcConfig *ServiceConfig) (*apphost.Manifest, error) + func (ai *DotNetImporter) Services(ctx context.Context, p *ProjectConfig, svcConfig *ServiceConfig) (map[string]*ServiceConfig, error) + type EmitEnv struct + FuncMap scaffold.FuncMap + ResourceVarName string + type EventHubsProps struct + Hubs []string + type ExternalFrameworkService struct + func (efs *ExternalFrameworkService) Build(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServiceBuildResult, error) + func (efs *ExternalFrameworkService) Initialize(ctx context.Context, serviceConfig *ServiceConfig) error + func (efs *ExternalFrameworkService) Package(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServicePackageResult, error) + func (efs *ExternalFrameworkService) RequiredExternalTools(ctx context.Context, serviceConfig *ServiceConfig) []tools.ExternalTool + func (efs *ExternalFrameworkService) Requirements() FrameworkRequirements + func (efs *ExternalFrameworkService) Restore(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServiceRestoreResult, error) + type ExternalServiceTarget struct + func (est *ExternalServiceTarget) Deploy(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServiceDeployResult, error) + func (est *ExternalServiceTarget) Endpoints(ctx context.Context, serviceConfig *ServiceConfig, ...) ([]string, error) + func (est *ExternalServiceTarget) Initialize(ctx context.Context, serviceConfig *ServiceConfig) error + func (est *ExternalServiceTarget) Package(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServicePackageResult, error) + func (est *ExternalServiceTarget) Publish(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServicePublishResult, error) + func (est *ExternalServiceTarget) RequiredExternalTools(ctx context.Context, serviceConfig *ServiceConfig) []tools.ExternalTool + func (est *ExternalServiceTarget) ResolveTargetResource(ctx context.Context, subscriptionId string, serviceConfig *ServiceConfig, ...) (*environment.TargetResource, error) + type FindOpts func(*findFilter) + func WithKind(kind ArtifactKind) FindOpts + func WithLocationKind(locationKind LocationKind) FindOpts + func WithTake(length int) FindOpts + type FrameworkPackageRequirements struct + RequireBuild bool + RequireRestore bool + type FrameworkRequirements struct + Package FrameworkPackageRequirements + type FrameworkService interface + Build func(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServiceBuildResult, error) + Initialize func(ctx context.Context, serviceConfig *ServiceConfig) error + Package func(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServicePackageResult, error) + RequiredExternalTools func(ctx context.Context, serviceConfig *ServiceConfig) []tools.ExternalTool + Requirements func() FrameworkRequirements + Restore func(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServiceRestoreResult, error) + func NewCustomProject(env *environment.Environment) FrameworkService + func NewDockerProjectAsFrameworkService(env *environment.Environment, docker *docker.Cli, ...) FrameworkService + func NewDotNetProject(dotNetCli *dotnet.Cli, env *environment.Environment) FrameworkService + func NewExternalFrameworkService(name string, kind ServiceLanguageKind, extension *extensions.Extension, ...) FrameworkService + func NewMavenProject(env *environment.Environment, mavenCli *maven.Cli, javaCli *javac.Cli) FrameworkService + func NewNoOpProject(env *environment.Environment) FrameworkService + func NewNodeProject(cli node.Cli, env *environment.Environment, commandRunner exec.CommandRunner) FrameworkService + func NewPythonProject(cli *python.Cli, env *environment.Environment) FrameworkService + func NewSwaProjectAsFrameworkService(env *environment.Environment, console input.Console, ...) FrameworkService + type HooksConfig map[string][]*ext.HookConfig + func (ch *HooksConfig) UnmarshalYAML(unmarshal func(any) error) error + func (ch HooksConfig) MarshalYAML() (any, error) + type ImportManager struct + func NewImportManager(dotNetImporter *DotNetImporter) *ImportManager + func (im *ImportManager) GenerateAllInfrastructure(ctx context.Context, projectConfig *ProjectConfig) (fs.FS, error) + func (im *ImportManager) HasAppHost(ctx context.Context, projectConfig *ProjectConfig) bool + func (im *ImportManager) HasService(ctx context.Context, projectConfig *ProjectConfig, name string) (bool, error) + func (im *ImportManager) ProjectInfrastructure(ctx context.Context, projectConfig *ProjectConfig) (*Infra, error) + func (im *ImportManager) ServiceStable(ctx context.Context, projectConfig *ProjectConfig) ([]*ServiceConfig, error) + func (im *ImportManager) ServiceStableFiltered(ctx context.Context, projectConfig *ProjectConfig, targetServiceName string, ...) ([]*ServiceConfig, error) + type Infra struct + IsCompose bool + Options provisioning.Options + func (i *Infra) Cleanup() error + type LocationKind string + const LocationKindLocal + const LocationKindRemote + type PackageOptions struct + OutputPath string + type PipelineOptions struct + Provider string + Secrets []string + Variables []string + type ProjectConfig struct + AdditionalProperties map[string]any + Cloud *cloud.Config + Hooks HooksConfig + Infra provisioning.Options + MetaSchemaVersion string + Metadata *ProjectMetadata + Name string + Path string + Pipeline PipelineOptions + Platform *platform.Config + RequiredVersions *RequiredVersions + ResourceGroupName osutil.ExpandableString + Resources map[string]*ResourceConfig + Services map[string]*ServiceConfig + State *state.Config + Workflows workflow.WorkflowMap + func Load(ctx context.Context, projectFilePath string) (*ProjectConfig, error) + func New(ctx context.Context, projectFilePath string, projectName string) (*ProjectConfig, error) + func Parse(ctx context.Context, yamlContent string) (*ProjectConfig, error) + type ProjectLifecycleEventArgs struct + Args map[string]any + Project *ProjectConfig + type ProjectLifecycleEventHandlerFn func(ctx context.Context, args ProjectLifecycleEventArgs) error + type ProjectManager interface + DefaultServiceFromWd func(ctx context.Context, projectConfig *ProjectConfig) (serviceConfig *ServiceConfig, err error) + EnsureAllTools func(ctx context.Context, projectConfig *ProjectConfig, ...) error + EnsureFrameworkTools func(ctx context.Context, projectConfig *ProjectConfig, ...) error + EnsureRestoreTools func(ctx context.Context, projectConfig *ProjectConfig, ...) error + EnsureServiceTargetTools func(ctx context.Context, projectConfig *ProjectConfig, ...) error + Initialize func(ctx context.Context, projectConfig *ProjectConfig) error + func NewProjectManager(azdContext *azdcontext.AzdContext, serviceManager ServiceManager, ...) ProjectManager + type ProjectMetadata struct + Template string + type PublishOptions struct + Image string + type RequiredVersions struct + Azd *string + Extensions map[string]*string + type ResourceConfig struct + Existing bool + IncludeName bool + Name string + Project *ProjectConfig + Props any + RawProps map[string]yaml.Node + ResourceId string + Type ResourceType + Uses []string + func DependentResourcesOf(resource *ResourceConfig) []*ResourceConfig + func (r *ResourceConfig) MarshalYAML() (any, error) + func (r *ResourceConfig) UnmarshalYAML(value *yaml.Node) error + type ResourceManager interface + GetResourceGroupName func(ctx context.Context, subscriptionId string, ...) (string, error) + GetServiceResource func(ctx context.Context, subscriptionId string, resourceGroupName string, ...) (*azapi.ResourceExtended, error) + GetServiceResources func(ctx context.Context, subscriptionId string, resourceGroupName string, ...) ([]*azapi.ResourceExtended, error) + GetTargetResource func(ctx context.Context, subscriptionId string, serviceConfig *ServiceConfig) (*environment.TargetResource, error) + func NewResourceManager(env *environment.Environment, deploymentService *azapi.StandardDeployments, ...) ResourceManager + type ResourceType string + const ResourceTypeAiProject + const ResourceTypeAiSearch + const ResourceTypeDbCosmos + const ResourceTypeDbMongo + const ResourceTypeDbMySql + const ResourceTypeDbPostgres + const ResourceTypeDbRedis + const ResourceTypeHostAppService + const ResourceTypeHostContainerApp + const ResourceTypeKeyVault + const ResourceTypeMessagingEventHubs + const ResourceTypeMessagingServiceBus + const ResourceTypeOpenAiModel + const ResourceTypeStorage + func AllResourceTypes() []ResourceType + func (r ResourceType) AzureResourceType() string + func (r ResourceType) String() string + type ServiceBuildResult struct + Artifacts ArtifactCollection + type ServiceBusProps struct + Queues []string + Topics []string + type ServiceConfig struct + AdditionalProperties map[string]any + ApiVersion string + BuildOnly bool + Condition osutil.ExpandableString + Config map[string]any + Docker DockerProjectOptions + DotNetContainerApp *DotNetContainerAppOptions + Environment osutil.ExpandableMap + Hooks HooksConfig + Host ServiceTargetKind + Image osutil.ExpandableString + Infra provisioning.Options + K8s AksOptions + Language ServiceLanguageKind + Module string + Name string + OutputPath string + Project *ProjectConfig + RelativePath string + RemoteBuild *bool + ResourceGroupName osutil.ExpandableString + ResourceName osutil.ExpandableString + Uses []string + func (sc *ServiceConfig) IsEnabled(getenv func(string) string) (bool, error) + func (sc *ServiceConfig) Path() string + type ServiceContext struct + Build ArtifactCollection + Deploy ArtifactCollection + Package ArtifactCollection + Publish ArtifactCollection + Restore ArtifactCollection + func NewServiceContext() *ServiceContext + type ServiceDeployResult struct + Artifacts ArtifactCollection + type ServiceEnvVar struct + Name string + Secret string + Value string + type ServiceFilterPredicate func(svc *ServiceConfig) bool + type ServiceLanguageKind string + const ServiceLanguageCsharp + const ServiceLanguageCustom + const ServiceLanguageDocker + const ServiceLanguageDotNet + const ServiceLanguageFsharp + const ServiceLanguageJava + const ServiceLanguageJavaScript + const ServiceLanguageNone + const ServiceLanguagePython + const ServiceLanguageSwa + const ServiceLanguageTypeScript + func (slk ServiceLanguageKind) IsDotNet() bool + type ServiceLifecycleEventArgs struct + Args map[string]any + Project *ProjectConfig + Service *ServiceConfig + ServiceContext *ServiceContext + type ServiceManager interface + Build func(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServiceBuildResult, error) + Deploy func(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServiceDeployResult, error) + GetFrameworkService func(ctx context.Context, serviceConfig *ServiceConfig) (FrameworkService, error) + GetRequiredTools func(ctx context.Context, serviceConfig *ServiceConfig) ([]tools.ExternalTool, error) + GetServiceTarget func(ctx context.Context, serviceConfig *ServiceConfig) (ServiceTarget, error) + GetTargetResource func(ctx context.Context, serviceConfig *ServiceConfig, serviceTarget ServiceTarget) (*environment.TargetResource, error) + Initialize func(ctx context.Context, serviceConfig *ServiceConfig) error + Package func(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServicePackageResult, error) + Publish func(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServicePublishResult, error) + Restore func(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServiceRestoreResult, error) + func NewServiceManager(env *environment.Environment, resourceManager ResourceManager, ...) ServiceManager + type ServiceOperationCache map[string]any + type ServicePackageResult struct + Artifacts ArtifactCollection + type ServiceProgress struct + Message string + Timestamp time.Time + func NewServiceProgress(message string) ServiceProgress + type ServicePublishResult struct + Artifacts ArtifactCollection + type ServiceRestoreResult struct + Artifacts ArtifactCollection + type ServiceTarget interface + Deploy func(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServiceDeployResult, error) + Endpoints func(ctx context.Context, serviceConfig *ServiceConfig, ...) ([]string, error) + Initialize func(ctx context.Context, serviceConfig *ServiceConfig) error + Package func(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServicePackageResult, error) + Publish func(ctx context.Context, serviceConfig *ServiceConfig, ...) (*ServicePublishResult, error) + RequiredExternalTools func(ctx context.Context, serviceConfig *ServiceConfig) []tools.ExternalTool + func NewAiEndpointTarget(env *environment.Environment, envManager environment.Manager, ...) ServiceTarget + func NewAksTarget(env *environment.Environment, envManager environment.Manager, ...) ServiceTarget + func NewAppServiceTarget(env *environment.Environment, azCli *azapi.AzureClient, console input.Console) ServiceTarget + func NewContainerAppTarget(env *environment.Environment, envManager environment.Manager, ...) ServiceTarget + func NewDotNetContainerAppTarget(env *environment.Environment, containerHelper *ContainerHelper, ...) ServiceTarget + func NewExternalServiceTarget(name string, kind ServiceTargetKind, extension *extensions.Extension, ...) ServiceTarget + func NewFunctionAppTarget(env *environment.Environment, azCli *azapi.AzureClient, console input.Console) ServiceTarget + func NewSpringAppTarget(env *environment.Environment, envManager environment.Manager) ServiceTarget + func NewStaticWebAppTarget(env *environment.Environment, azCli *azapi.AzureClient, swaCli *swa.Cli) ServiceTarget + type ServiceTargetKind string + const AiEndpointTarget + const AksTarget + const AppServiceTarget + const AzureFunctionTarget + const ContainerAppTarget + const DotNetContainerAppTarget + const NonSpecifiedTarget + const SpringAppTarget + const StaticWebAppTarget + func BuiltInServiceTargetKinds() []ServiceTargetKind + func (st ServiceTargetKind) IgnoreFile() string + func (st ServiceTargetKind) SupportsDelayedProvisioning() bool + func (stk ServiceTargetKind) RequiresContainer() bool + type StorageProps struct + Containers []string + type TargetResourceResolver interface + ResolveTargetResource func(ctx context.Context, subscriptionId string, serviceConfig *ServiceConfig, ...) (*environment.TargetResource, error) + type UnsupportedServiceHostError struct + ErrorMessage string + Host string + ServiceName string + func (e *UnsupportedServiceHostError) Error() string
Go to main page