ExecutableResource Class

Reference

Definition

Namespace:: Aspire.Hosting.ApplicationModel

Assembly:: Aspire.Hosting.dll

Package:: Aspire.Hosting v8.2.0

Package:: Aspire.Hosting v9.0.0

Package:: Aspire.Hosting v9.1.0

Package:: Aspire.Hosting v9.2.0

Package:: Aspire.Hosting v9.3.0

Source:: ExecutableResource.cs

Source:: ExecutableResource.cs

Source:: ExecutableResource.cs

Source:: ExecutableResource.cs

Source:: ExecutableResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A resource that represents a specified executable process.

public class ExecutableResource : Aspire.Hosting.ApplicationModel.Resource, Aspire.Hosting.ApplicationModel.IResourceWithArgs, Aspire.Hosting.ApplicationModel.IResourceWithEndpoints, Aspire.Hosting.ApplicationModel.IResourceWithEnvironment

public class ExecutableResource : Aspire.Hosting.ApplicationModel.Resource, Aspire.Hosting.ApplicationModel.IResourceWithArgs, Aspire.Hosting.ApplicationModel.IResourceWithEndpoints, Aspire.Hosting.ApplicationModel.IResourceWithEnvironment, Aspire.Hosting.ApplicationModel.IResourceWithWaitSupport

public class ExecutableResource : Aspire.Hosting.ApplicationModel.Resource, Aspire.Hosting.ApplicationModel.IComputeResource, Aspire.Hosting.ApplicationModel.IResourceWithArgs, Aspire.Hosting.ApplicationModel.IResourceWithEndpoints, Aspire.Hosting.ApplicationModel.IResourceWithEnvironment, Aspire.Hosting.ApplicationModel.IResourceWithWaitSupport

type ExecutableResource = class
    inherit Resource
    interface IResourceWithEnvironment
    interface IResource
    interface IResourceWithArgs
    interface IResourceWithEndpoints

type ExecutableResource = class
    inherit Resource
    interface IResourceWithEnvironment
    interface IResource
    interface IResourceWithArgs
    interface IResourceWithEndpoints
    interface IResourceWithWaitSupport

type ExecutableResource = class
    inherit Resource
    interface IResourceWithEnvironment
    interface IResource
    interface IResourceWithArgs
    interface IResourceWithEndpoints
    interface IResourceWithWaitSupport
    interface IComputeResource

Public Class ExecutableResource
Inherits Resource
Implements IResourceWithArgs, IResourceWithEndpoints, IResourceWithEnvironment

Public Class ExecutableResource
Inherits Resource
Implements IResourceWithArgs, IResourceWithEndpoints, IResourceWithEnvironment, IResourceWithWaitSupport

Public Class ExecutableResource
Inherits Resource
Implements IComputeResource, IResourceWithArgs, IResourceWithEndpoints, IResourceWithEnvironment, IResourceWithWaitSupport

Inheritance: Object

Resource
ExecutableResource

Derived: Aspire.Hosting.NodeAppResource

Aspire.Hosting.Python.PythonAppResource

Aspire.Hosting.Python.PythonProjectResource

Implements: IResource IResourceWithArgs IResourceWithEndpoints IResourceWithEnvironment IResourceWithWaitSupport IComputeResource

Remarks

You can run any executable command using its full path. As a security feature, Aspire doesn't run executable unless the command is located in a path listed in the PATH environment variable.

To run an executable file that's in the current directory, specify the full path or use the relative path ./ to represent the current directory.

Constructors

ExecutableResource(String, String, String)

A resource that represents a specified executable process.

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
Command	Gets the command associated with this executable resource.
Name	Gets the name of the resource. (Inherited from Resource)
WorkingDirectory	Gets the working directory for the executable resource.

Extension Methods

GetArgumentValuesAsync(IResourceWithArgs, DistributedApplicationOperation)	Get the arguments from the given resource.
GetDeploymentTargetAnnotation(IResource, IComputeEnvironmentResource)	Gets the deployment target for the specified resource, if any. Throws an exception if there are multiple compute environments and a compute environment is not explicitly specified.
GetEndpoint(IResourceWithEndpoints, String)	Gets an endpoint reference for the specified endpoint name.
GetEndpoints(IResourceWithEndpoints)	Gets the endpoints for the specified resource.
GetEnvironmentVariableValuesAsync(IResourceWithEnvironment, DistributedApplicationOperation)	Get the environment variables from the given resource.
GetReplicaCount(IResource)	Gets the number of replicas for the specified resource. Defaults to `1` if no ReplicaAnnotation is found.
HasAnnotationIncludingAncestorsOfType<T>(IResource)	Gets whether `resource` or its ancestors have an annotation of type `T`
HasAnnotationOfType<T>(IResource)	Gets whether `resource` has an annotation of type `T`
ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, String, CancellationToken)	Processes argument values for the specified resource in the given execution context.
ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, String, CancellationToken)	Processes environment variable values for the specified resource within the given execution context.
TryGetAnnotationsIncludingAncestorsOfType<T>(IResource, IEnumerable<T>)	Attempts to retrieve all annotations of the specified type from the given resource including from parents.
TryGetAnnotationsOfType<T>(IResource, IEnumerable<T>)	Attempts to retrieve all annotations of the specified type from the given resource.
TryGetContainerImageName(IResource, String)	Attempts to get the container image name from the given resource.
TryGetContainerMounts(IResource, IEnumerable<ContainerMountAnnotation>)	Attempts to get the container mounts for the specified resource.
TryGetEndpoints(IResource, IEnumerable<EndpointAnnotation>)	Attempts to retrieve the endpoints for the given resource.
TryGetEnvironmentVariables(IResource, IEnumerable<EnvironmentCallbackAnnotation>)	Attempts to get the environment variables from the given resource.
TryGetLastAnnotation<T>(IResource, T)	Attempts to get the last annotation of the specified type from the resource.
TryGetUrls(IResource, IEnumerable<ResourceUrlAnnotation>)	Attempts to retrieve the URLs for the given resource.
IsContainer(IResource)	Determines whether the specified resource is a container resource.
IsExisting(IResource)	Determines if the resource is an existing resource.

Applies to

Share via