project

package
v1.30.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 5, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewDemoFrameworkServiceProvider 

func NewDemoFrameworkServiceProvider(azdClient *azdext.AzdClient) azdext.FrameworkServiceProvider

NewDemoFrameworkServiceProvider creates a new DemoFrameworkServiceProvider instance

func NewDemoProvisioningProvider added in v1.24.2 

func NewDemoProvisioningProvider(
	azdClient *azdext.AzdClient,
) azdext.ProvisioningProvider

NewDemoProvisioningProvider creates a new DemoProvisioningProvider instance

func NewDemoServiceTargetProvider 

func NewDemoServiceTargetProvider(azdClient *azdext.AzdClient) azdext.ServiceTargetProvider

NewDemoServiceTargetProvider creates a new DemoServiceTargetProvider instance

Types

type DemoFrameworkServiceProvider 

type DemoFrameworkServiceProvider struct {
	// contains filtered or unexported fields
}

DemoFrameworkServiceProvider is a demonstration implementation of a framework service provider This shows how to implement support for a custom language/framework that isn't built into azd

func (*DemoFrameworkServiceProvider) Build 

func (p *DemoFrameworkServiceProvider) Build(
	ctx context.Context,
	serviceConfig *azdext.ServiceConfig,
	serviceContext *azdext.ServiceContext,
	progress azdext.ProgressReporter,
) (*azdext.ServiceBuildResult, error)

Build compiles the application

func (*DemoFrameworkServiceProvider) Initialize 

func (p *DemoFrameworkServiceProvider) Initialize(ctx context.Context, serviceConfig *azdext.ServiceConfig) error

Initialize initializes the framework service provider with service configuration

func (*DemoFrameworkServiceProvider) Package 

func (p *DemoFrameworkServiceProvider) Package(
	ctx context.Context,
	serviceConfig *azdext.ServiceConfig,
	serviceContext *azdext.ServiceContext,
	progress azdext.ProgressReporter,
) (*azdext.ServicePackageResult, error)

Package performs packaging (creating deployable artifacts)

func (*DemoFrameworkServiceProvider) RequiredExternalTools 

func (p *DemoFrameworkServiceProvider) RequiredExternalTools(
	ctx context.Context,
	serviceConfig *azdext.ServiceConfig,
) ([]*azdext.ExternalTool, error)

RequiredExternalTools returns the external tools required by this framework

func (*DemoFrameworkServiceProvider) Requirements 

func (p *DemoFrameworkServiceProvider) Requirements() (*azdext.FrameworkRequirements, error)

Requirements returns the framework requirements (whether restore/build are needed)

func (*DemoFrameworkServiceProvider) Restore 

func (p *DemoFrameworkServiceProvider) Restore(
	ctx context.Context,
	serviceConfig *azdext.ServiceConfig,
	serviceContext *azdext.ServiceContext,
	progress azdext.ProgressReporter,
) (*azdext.ServiceRestoreResult, error)

Restore performs package restore/install for dependencies

type DemoProvisionValidationCheck added in v1.27.1 

type DemoProvisionValidationCheck struct{}

DemoProvisionValidationCheck is a sample provider-agnostic validation check. Unlike DemoValidationCheck (which relies on the Bicep snapshot), this check registers under the "provision" check type and therefore runs before provisioning for every provider — including this demo extension's own provisioning provider. It demonstrates reading the lean provision context; see azdext.ValidationContext (and azdext.ValidationCheckTypeProvision) for the authoritative description of that context's contents.

func NewDemoProvisionValidationCheck added in v1.27.1 

func NewDemoProvisionValidationCheck() *DemoProvisionValidationCheck

NewDemoProvisionValidationCheck creates a new DemoProvisionValidationCheck.

func (*DemoProvisionValidationCheck) Validate added in v1.27.1 

func (c *DemoProvisionValidationCheck) Validate(
	_ context.Context,
	valCtx *azdext.ValidationContext,
	_ *azdext.ValidationCheckRequest,
) (*azdext.ValidationCheckResponse, error)

Validate implements azdext.ValidationCheckProvider.

type DemoProvisioningProvider added in v1.24.2 

type DemoProvisioningProvider struct {
	// contains filtered or unexported fields
}

DemoProvisioningProvider is a demonstration implementation of a provisioning provider. This shows how to implement infrastructure provisioning support as an azd extension.

func (*DemoProvisioningProvider) Deploy added in v1.24.2 

func (p *DemoProvisioningProvider) Deploy(
	ctx context.Context,
	progress grpcbroker.ProgressFunc,
) (*azdext.ProvisioningDeployResult, error)

Deploy simulates a multi-step infrastructure deployment with progress updates

func (*DemoProvisioningProvider) Destroy added in v1.24.2 

func (p *DemoProvisioningProvider) Destroy(
	ctx context.Context,
	options *azdext.ProvisioningDestroyOptions,
	progress grpcbroker.ProgressFunc,
) (*azdext.ProvisioningDestroyResult, error)

Destroy simulates infrastructure destruction with progress updates

func (*DemoProvisioningProvider) EnsureEnv added in v1.24.2 

func (p *DemoProvisioningProvider) EnsureEnv(ctx context.Context) error

EnsureEnv ensures the environment is properly configured for provisioning

func (*DemoProvisioningProvider) Initialize added in v1.24.2 

func (p *DemoProvisioningProvider) Initialize(
	ctx context.Context,
	projectPath string,
	options *azdext.ProvisioningOptions,
) error

Initialize initializes the provisioning provider with the project path and options

func (*DemoProvisioningProvider) Parameters added in v1.24.2 

func (p *DemoProvisioningProvider) Parameters(
	ctx context.Context,
) ([]*azdext.ProvisioningParameter, error)

Parameters returns sample provisioning parameters

func (*DemoProvisioningProvider) PlannedOutputs added in v1.24.2 

func (p *DemoProvisioningProvider) PlannedOutputs(
	ctx context.Context,
) ([]*azdext.ProvisioningPlannedOutput, error)

PlannedOutputs returns the list of outputs this provider plans to produce

func (*DemoProvisioningProvider) Preview added in v1.24.2 

func (p *DemoProvisioningProvider) Preview(
	ctx context.Context,
	progress grpcbroker.ProgressFunc,
) (*azdext.ProvisioningPreviewResult, error)

Preview returns a simulated preview of the deployment plan

func (*DemoProvisioningProvider) State added in v1.24.2 

func (p *DemoProvisioningProvider) State(
	ctx context.Context,
	options *azdext.ProvisioningStateOptions,
) (*azdext.ProvisioningStateResult, error)

State returns the current provisioning state with sample outputs and resources

type DemoServiceTargetProvider 

type DemoServiceTargetProvider struct {
	// contains filtered or unexported fields
}

DemoServiceTargetProvider is a minimal implementation of ServiceTargetProvider for demonstration

func (*DemoServiceTargetProvider) Deploy 

func (p *DemoServiceTargetProvider) Deploy(
	ctx context.Context,
	serviceConfig *azdext.ServiceConfig,
	serviceContext *azdext.ServiceContext,
	targetResource *azdext.TargetResource,
	progress azdext.ProgressReporter,
) (*azdext.ServiceDeployResult, error)

Deploy performs the deployment operation for the service

func (*DemoServiceTargetProvider) Endpoints 

func (p *DemoServiceTargetProvider) Endpoints(
	ctx context.Context,
	serviceConfig *azdext.ServiceConfig,
	targetResource *azdext.TargetResource,
) ([]string, error)

Endpoints returns endpoints exposed by the service

func (*DemoServiceTargetProvider) GetTargetResource 

func (p *DemoServiceTargetProvider) GetTargetResource(
	ctx context.Context,
	subscriptionId string,
	serviceConfig *azdext.ServiceConfig,
	defaultResolver func() (*azdext.TargetResource, error),
) (*azdext.TargetResource, error)

GetTargetResource returns a target resource for the service

func (*DemoServiceTargetProvider) Initialize 

func (p *DemoServiceTargetProvider) Initialize(ctx context.Context, serviceConfig *azdext.ServiceConfig) error

Initialize initializes the service target provider with service configuration

func (*DemoServiceTargetProvider) Package 

func (p *DemoServiceTargetProvider) Package(
	ctx context.Context,
	serviceConfig *azdext.ServiceConfig,
	serviceContext *azdext.ServiceContext,
	progress azdext.ProgressReporter,
) (*azdext.ServicePackageResult, error)

Package performs packaging for the service

func (*DemoServiceTargetProvider) Publish 

func (p *DemoServiceTargetProvider) Publish(
	ctx context.Context,
	serviceConfig *azdext.ServiceConfig,
	serviceContext *azdext.ServiceContext,
	targetResource *azdext.TargetResource,
	publishOptions *azdext.PublishOptions,
	progress azdext.ProgressReporter,
) (*azdext.ServicePublishResult, error)

Publish performs the publish operation for the service

type DemoValidationCheck added in v1.26.0 

type DemoValidationCheck struct{}

DemoValidationCheck is a sample validation check that always returns a warning to demonstrate the validation-provider capability.

func NewDemoValidationCheck added in v1.26.0 

func NewDemoValidationCheck() *DemoValidationCheck

NewDemoValidationCheck creates a new DemoValidationCheck.

func (*DemoValidationCheck) Validate added in v1.26.0 

func (c *DemoValidationCheck) Validate(
	_ context.Context,
	valCtx *azdext.ValidationContext,
	_ *azdext.ValidationCheckRequest,
) (*azdext.ValidationCheckResponse, error)

Validate implements azdext.ValidationCheckProvider.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.