DevTunnelsResourceBuilderExtensions.WithReference Method
Definition
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.
Overloads
| WithReference(IResourceBuilder<DevTunnelResource>, EndpointReference) |
Exposes the specified endpoint via the dev tunnel. |
| WithReference(IResourceBuilder<DevTunnelResource>, EndpointReference, DevTunnelPortOptions) |
Exposes the specified endpoint via the dev tunnel. |
| WithReference(IResourceBuilder<DevTunnelResource>, EndpointReference, Boolean) |
Exposes the specified endpoint via the dev tunnel and sets whether anonymous access is allowed. |
| WithReference<TResource>(IResourceBuilder<DevTunnelResource>, IResourceBuilder<TResource>, DevTunnelPortOptions) |
Adds ports on the dev tunnel for all endpoints found on the referenced resource. |
| WithReference<TResource>(IResourceBuilder<DevTunnelResource>, IResourceBuilder<TResource>, Boolean) |
Adds ports on the dev tunnel for all endpoints found on the referenced resource and sets whether anonymous access is allowed. |
| WithReference<TResource>(IResourceBuilder<TResource>, IResourceBuilder<IResourceWithEndpoints>, IResourceBuilder<DevTunnelResource>) |
Injects service discovery information as environment variables from the dev tunnel resource into the destination resource, using the tunneled resource's name as the service name. Each endpoint defined on the target resource will be injected using the format "services__{sourceResourceName}{endpointName}{endpointIndex}={uriString}". |
WithReference(IResourceBuilder<DevTunnelResource>, EndpointReference)
Exposes the specified endpoint via the dev tunnel.
public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> WithReference(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> tunnelBuilder, Aspire.Hosting.ApplicationModel.EndpointReference targetEndpoint);static member WithReference : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> * Aspire.Hosting.ApplicationModel.EndpointReference -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource><Extension()>
Public Function WithReference (tunnelBuilder As IResourceBuilder(Of DevTunnelResource), targetEndpoint As EndpointReference) As IResourceBuilder(Of DevTunnelResource)Parameters
- tunnelBuilder
- IResourceBuilder<DevTunnelResource>
The resource builder.
- targetEndpoint
- EndpointReference
The endpoint to expose via the dev tunnel.
Returns
The resource builder.
Applies to
WithReference(IResourceBuilder<DevTunnelResource>, EndpointReference, DevTunnelPortOptions)
Exposes the specified endpoint via the dev tunnel.
public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> WithReference(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> tunnelBuilder, Aspire.Hosting.ApplicationModel.EndpointReference targetEndpoint, Aspire.Hosting.DevTunnels.DevTunnelPortOptions? portOptions);static member WithReference : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> * Aspire.Hosting.ApplicationModel.EndpointReference * Aspire.Hosting.DevTunnels.DevTunnelPortOptions -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource><Extension()>
Public Function WithReference (tunnelBuilder As IResourceBuilder(Of DevTunnelResource), targetEndpoint As EndpointReference, portOptions As DevTunnelPortOptions) As IResourceBuilder(Of DevTunnelResource)Parameters
- tunnelBuilder
- IResourceBuilder<DevTunnelResource>
The resource builder.
- targetEndpoint
- EndpointReference
The endpoint to expose via the dev tunnel.
- portOptions
- DevTunnelPortOptions
Options for the dev tunnel port.
Returns
The resource builder.
Applies to
WithReference(IResourceBuilder<DevTunnelResource>, EndpointReference, Boolean)
Exposes the specified endpoint via the dev tunnel and sets whether anonymous access is allowed.
public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> WithReference(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> tunnelBuilder, Aspire.Hosting.ApplicationModel.EndpointReference targetEndpoint, bool allowAnonymous);static member WithReference : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> * Aspire.Hosting.ApplicationModel.EndpointReference * bool -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource><Extension()>
Public Function WithReference (tunnelBuilder As IResourceBuilder(Of DevTunnelResource), targetEndpoint As EndpointReference, allowAnonymous As Boolean) As IResourceBuilder(Of DevTunnelResource)Parameters
- tunnelBuilder
- IResourceBuilder<DevTunnelResource>
The resource builder.
- targetEndpoint
- EndpointReference
The endpoint to expose via the dev tunnel.
- allowAnonymous
- Boolean
Whether anonymous access is allowed.
Returns
The resource builder.
Applies to
WithReference<TResource>(IResourceBuilder<DevTunnelResource>, IResourceBuilder<TResource>, DevTunnelPortOptions)
Adds ports on the dev tunnel for all endpoints found on the referenced resource.
public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> WithReference<TResource>(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> tunnelBuilder, Aspire.Hosting.ApplicationModel.IResourceBuilder<TResource> resourceBuilder, Aspire.Hosting.DevTunnels.DevTunnelPortOptions? portOptions = default) where TResource : Aspire.Hosting.ApplicationModel.IResourceWithEndpoints;static member WithReference : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> * Aspire.Hosting.ApplicationModel.IResourceBuilder<'Resource (requires 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithEndpoints)> * Aspire.Hosting.DevTunnels.DevTunnelPortOptions -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> (requires 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithEndpoints)<Extension()>
Public Function WithReference(Of TResource As IResourceWithEndpoints) (tunnelBuilder As IResourceBuilder(Of DevTunnelResource), resourceBuilder As IResourceBuilder(Of TResource), Optional portOptions As DevTunnelPortOptions = Nothing) As IResourceBuilder(Of DevTunnelResource)Type Parameters
- TResource
Parameters
- tunnelBuilder
- IResourceBuilder<DevTunnelResource>
The resource builder.
- resourceBuilder
- IResourceBuilder<TResource>
The resource builder for the referenced resource.
- portOptions
- DevTunnelPortOptions
Options for the dev tunnel ports.
Returns
The resource builder.
Remarks
To expose only specific endpoints on the referenced resource, use WithReference(IResourceBuilder<DevTunnelResource>, EndpointReference, DevTunnelPortOptions).
Applies to
WithReference<TResource>(IResourceBuilder<DevTunnelResource>, IResourceBuilder<TResource>, Boolean)
Adds ports on the dev tunnel for all endpoints found on the referenced resource and sets whether anonymous access is allowed.
public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> WithReference<TResource>(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> tunnelBuilder, Aspire.Hosting.ApplicationModel.IResourceBuilder<TResource> resourceBuilder, bool allowAnonymous) where TResource : Aspire.Hosting.ApplicationModel.IResourceWithEndpoints;static member WithReference : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> * Aspire.Hosting.ApplicationModel.IResourceBuilder<'Resource (requires 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithEndpoints)> * bool -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> (requires 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithEndpoints)<Extension()>
Public Function WithReference(Of TResource As IResourceWithEndpoints) (tunnelBuilder As IResourceBuilder(Of DevTunnelResource), resourceBuilder As IResourceBuilder(Of TResource), allowAnonymous As Boolean) As IResourceBuilder(Of DevTunnelResource)Type Parameters
- TResource
Parameters
- tunnelBuilder
- IResourceBuilder<DevTunnelResource>
The resource builder.
- resourceBuilder
- IResourceBuilder<TResource>
The resource builder for the referenced resource.
- allowAnonymous
- Boolean
Whether anonymous access is allowed.
Returns
The resource builder.
Applies to
WithReference<TResource>(IResourceBuilder<TResource>, IResourceBuilder<IResourceWithEndpoints>, IResourceBuilder<DevTunnelResource>)
Injects service discovery information as environment variables from the dev tunnel resource into the destination resource, using the tunneled resource's name as the service name. Each endpoint defined on the target resource will be injected using the format "services__{sourceResourceName}{endpointName}{endpointIndex}={uriString}".
public static Aspire.Hosting.ApplicationModel.IResourceBuilder<TResource> WithReference<TResource>(this Aspire.Hosting.ApplicationModel.IResourceBuilder<TResource> builder, Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.IResourceWithEndpoints> targetResource, Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> tunnelResource) where TResource : Aspire.Hosting.ApplicationModel.IResourceWithEnvironment;static member WithReference : Aspire.Hosting.ApplicationModel.IResourceBuilder<'Resource (requires 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithEnvironment)> * Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.IResourceWithEndpoints> * Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.DevTunnels.DevTunnelResource> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<'Resource (requires 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithEnvironment)> (requires 'Resource :> Aspire.Hosting.ApplicationModel.IResourceWithEnvironment)<Extension()>
Public Function WithReference(Of TResource As IResourceWithEnvironment) (builder As IResourceBuilder(Of TResource), targetResource As IResourceBuilder(Of IResourceWithEndpoints), tunnelResource As IResourceBuilder(Of DevTunnelResource)) As IResourceBuilder(Of TResource)Type Parameters
- TResource
Parameters
- builder
- IResourceBuilder<TResource>
The builder.
- targetResource
- IResourceBuilder<IResourceWithEndpoints>
The resource to inject service discovery information for.
- tunnelResource
- IResourceBuilder<DevTunnelResource>
The dev tunnel resource to resolve the tunnel address from.
Returns
The builder.
Remarks
Referencing a dev tunnel will delay the start of the resource until the referenced dev tunnel's endpoint is allocated.