DevTunnelPortResource Class

Definition

Namespace:: Aspire.Hosting.DevTunnels

Assembly:: Aspire.Hosting.DevTunnels.dll

Package:: Aspire.Hosting.DevTunnels v13.0.0-preview.1.25560.3

Package:: Aspire.Hosting.DevTunnels v9.5.0-preview.1.25474.7

Source:: DevTunnelResource.cs

Source:: DevTunnelResource.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 representing a single forwarded endpoint/port on a dev tunnel. Contains an endpoint that resolves to the public tunnel URL of this port.

public sealed class DevTunnelPortResource : Aspire.Hosting.ApplicationModel.Resource, Aspire.Hosting.ApplicationModel.IResourceWithWaitSupport, Aspire.Hosting.IResourceWithServiceDiscovery

type DevTunnelPortResource = class
    inherit Resource
    interface IResourceWithServiceDiscovery
    interface IResourceWithEndpoints
    interface IResource
    interface IResourceWithWaitSupport

Public NotInheritable Class DevTunnelPortResource
Inherits Resource
Implements IResourceWithServiceDiscovery, IResourceWithWaitSupport

Inheritance: Object

Resource
DevTunnelPortResource

Implements: IResource IResourceWithEndpoints IResourceWithWaitSupport IResourceWithServiceDiscovery

Constructors

DevTunnelPortResource(String, DevTunnelResource, EndpointReference, DevTunnelPortOptions)

Initializes a new instance of the DevTunnelPortResource class, representing a single forwarded endpoint/port on a dev tunnel.

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
DevTunnel	The dev tunnel this port belongs to.
Name	Gets the name of the resource. (Inherited from Resource)
Options	Options controlling how this port is exposed.

Extension Methods

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, NetworkIdentifier)	Gets an endpoint reference for the specified endpoint name.
GetEndpoint(IResourceWithEndpoints, String)	Gets an endpoint reference for the specified endpoint name.
GetEndpoints(IResourceWithEndpoints, NetworkIdentifier)	Gets references to all endpoints for the specified resource.
GetEndpoints(IResourceWithEndpoints)	Gets references to all endpoints for the specified 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`
IsExcludedFromPublish(IResource)	Gets a value indicating whether the resource is excluded from being published.
ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, String, CancellationToken)	Processes argument values for the specified resource in the given execution context.
ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, 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.
ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, CancellationToken)	Processes environment variable values for the specified resource within the given execution context.
RequiresImageBuild(IResource)	Determines whether the specified resource requires image building.
RequiresImageBuildAndPush(IResource)	Determines whether the specified resource requires image building and pushing.
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, Boolean, String)	Attempts to get the container image name 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.
IsEmulator(IResource)	Determines whether the specified resource is an emulator resource.
IsExisting(IResource)	Determines if the resource is an existing resource.

Applies to

Feedback

Was this page helpful?