AzureFunctionsProjectResource Class

Definition

Namespace:

Aspire.Hosting.Azure

Assembly:

Aspire.Hosting.Azure.Functions.dll

Package:

Aspire.Hosting.Azure.Functions v9.0.0-preview.5.24551.3

Source:

AzureFunctionsResource.cs

Represents an Azure Functions project resource within the Aspire hosting environment.

public class AzureFunctionsProjectResource : Aspire.Hosting.ApplicationModel.ProjectResource

type AzureFunctionsProjectResource = class
    inherit ProjectResource

Public Class AzureFunctionsProjectResource
Inherits ProjectResource

Inheritance

Object

Resource

ProjectResource

AzureFunctionsProjectResource

Remarks

This class is used to define and manage the configuration of an Azure Functions project, including its associated host storage. We create a strongly-typed resource for the Azure Functions to support Functions-specific customizations, like the mapping of connection strings and configurations for host storage. ///

Constructors

AzureFunctionsProjectResource(String)

Represents an Azure Functions project resource within the Aspire hosting environment.

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
Name	Gets the name of the resource. (Inherited from Resource)

Extension Methods

GetProjectMetadata(ProjectResource)	Gets the project metadata for the specified project resource.
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.
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.
IsContainer(IResource)	Determines whether the specified resource is a container resource.