IResource
Interface TypeScript
interface IResource { excludeFromManifest(): IResource; excludeFromMcp(): IResource; getResourceName(): string; withAppConfigurationRoleAssignments( target: AzureAppConfigurationResource, roles: AzureAppConfigurationRole[]): IResource; withChildRelationship(child: IResource): IResource; withCommand(name: string, displayName: string, executeCommand: (arg: ExecuteCommandContext) => ExecuteCommandResult, commandOptions?: CommandOptions): IResource; withContainerRegistry(registry: IResource): IResource; withDockerfileBaseImage( buildImage?: string, runtimeImage?: string): IResource; withExplicitStart(): IResource; withHealthCheck(key: string): IResource; withIconName( iconName: string, iconVariant?: IconVariant): IResource; withParentRelationship(parent: IResource): IResource; withPipelineConfiguration(callback: (obj: PipelineConfigurationContext) => void): IResource; withPipelineConfigurationAsync(callback: (arg: PipelineConfigurationContext) => void): IResource; withPipelineStepFactory(stepName: string, callback: (arg: PipelineStepContext) => void, dependsOn?: string[], requiredBy?: string[], tags?: string[], description?: string): IResource; withRemoteImageName(remoteImageName: string): IResource; withRemoteImageTag(remoteImageTag: string): IResource; withRequiredCommand( command: string, helpLink?: string): IResource; withUrl( url: string, displayText?: string): IResource; withUrlExpression( url: ReferenceExpression, displayText?: string): IResource; withUrlForEndpoint(endpointName: string, callback: (obj: ResourceUrlAnnotation) => void): IResource; withUrlsCallback(callback: (obj: ResourceUrlsCallbackContext) => void): IResource; withUrlsCallbackAsync(callback: (arg: ResourceUrlsCallbackContext) => void): IResource;} 23 members
Methods
method
excludeFromManifest builder Excludes the resource from the deployment manifest
excludeFromManifest(): IResourceReturns
IResource method
excludeFromMcp builder Excludes the resource from MCP server exposure
excludeFromMcp(): IResourceReturns
IResource method
getResourceName Gets the resource name
getResourceName(): stringReturns
string method
withAppConfigurationRoleAssignments builder Assigns App Configuration roles to a resource
withAppConfigurationRoleAssignments( target: AzureAppConfigurationResource, roles: AzureAppConfigurationRole[]): IResourceParameters
target AzureAppConfigurationResource roles AzureAppConfigurationRole[] Returns
IResource method
withChildRelationship builder Sets a child relationship
withChildRelationship(child: IResource): IResourceParameters
child IResource Returns
IResource method
withCommand builder Adds a resource command
withCommand(name: string, displayName: string, executeCommand: (arg: ExecuteCommandContext) => ExecuteCommandResult, commandOptions?: CommandOptions): IResourceParameters
name string displayName string executeCommand (arg: ExecuteCommandContext) => ExecuteCommandResult commandOptions CommandOptions optional Returns
IResource method
withContainerRegistry builder Configures a resource to use a container registry
withContainerRegistry(registry: IResource): IResourceParameters
registry IResource Returns
IResource method
withDockerfileBaseImage builder Sets the base image for a Dockerfile build
withDockerfileBaseImage( buildImage?: string, runtimeImage?: string): IResourceParameters
buildImage string optional runtimeImage string optional Returns
IResource method
withExplicitStart builder Prevents resource from starting automatically
withExplicitStart(): IResourceReturns
IResource method
withHealthCheck builder Adds a health check by key
withHealthCheck(key: string): IResourceParameters
key string Returns
IResource method
withIconName builder Sets the icon for the resource
withIconName( iconName: string, iconVariant?: IconVariant): IResourceParameters
iconName string iconVariant IconVariant optional = Filled Returns
IResource method
withParentRelationship builder Sets the parent relationship
withParentRelationship(parent: IResource): IResourceParameters
parent IResource Returns
IResource method
withPipelineConfiguration builder Configures pipeline step dependencies via a callback
withPipelineConfiguration(callback: (obj: PipelineConfigurationContext) => void): IResourceParameters
callback (obj: PipelineConfigurationContext) => void Returns
IResource method
withPipelineConfigurationAsync builder Configures pipeline step dependencies via an async callback
withPipelineConfigurationAsync(callback: (arg: PipelineConfigurationContext) => void): IResourceParameters
callback (arg: PipelineConfigurationContext) => void Returns
IResource method
withPipelineStepFactory builder Adds a pipeline step to the resource
withPipelineStepFactory(stepName: string, callback: (arg: PipelineStepContext) => void, dependsOn?: string[], requiredBy?: string[], tags?: string[], description?: string): IResourceParameters
stepName string callback (arg: PipelineStepContext) => void dependsOn string[] optional requiredBy string[] optional tags string[] optional description string optional Returns
IResource method
withRemoteImageName builder Sets the remote image name for publishing
withRemoteImageName(remoteImageName: string): IResourceParameters
remoteImageName string Returns
IResource method
withRemoteImageTag builder Sets the remote image tag for publishing
withRemoteImageTag(remoteImageTag: string): IResourceParameters
remoteImageTag string Returns
IResource method
withRequiredCommand builder Adds a required command dependency
withRequiredCommand( command: string, helpLink?: string): IResourceParameters
command string helpLink string optional Returns
IResource method
withUrl builder Adds or modifies displayed URLs
withUrl( url: string, displayText?: string): IResourceParameters
url string displayText string optional Returns
IResource method
withUrlExpression builder Adds a URL using a reference expression
withUrlExpression( url: ReferenceExpression, displayText?: string): IResourceParameters
url ReferenceExpression displayText string optional Returns
IResource method
withUrlForEndpoint builder Customizes the URL for a specific endpoint via callback
withUrlForEndpoint(endpointName: string, callback: (obj: ResourceUrlAnnotation) => void): IResourceParameters
endpointName string callback (obj: ResourceUrlAnnotation) => void Returns
IResource method
withUrlsCallback builder Customizes displayed URLs via callback
withUrlsCallback(callback: (obj: ResourceUrlsCallbackContext) => void): IResourceParameters
callback (obj: ResourceUrlsCallbackContext) => void Returns
IResource method
withUrlsCallbackAsync builder Customizes displayed URLs via async callback
withUrlsCallbackAsync(callback: (arg: ResourceUrlsCallbackContext) => void): IResourceParameters
callback (arg: ResourceUrlsCallbackContext) => void Returns
IResource