ContainerResource Class

Reference

Definition

Namespace:: Aspire.Hosting.ApplicationModel

Assembly:: Aspire.Hosting.dll

Package:: Aspire.Hosting v8.2.0

Package:: Aspire.Hosting v9.0.0

Source:: ContainerResource.cs

Source:: ContainerResource.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 container.

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

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

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

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

Public Class ContainerResource
Inherits Resource
Implements IResourceWithArgs, IResourceWithEndpoints, IResourceWithEnvironment

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

Inheritance: Object

Resource
ContainerResource

Derived: Aspire.Hosting.ApplicationModel.ElasticsearchResource

Aspire.Hosting.ApplicationModel.GarnetResource

Aspire.Hosting.ApplicationModel.KeycloakResource

Aspire.Hosting.ApplicationModel.MongoDBServerResource

Aspire.Hosting.ApplicationModel.MySqlServerResource

More…

Implements: IResource IResourceWithArgs IResourceWithEndpoints IResourceWithEnvironment IResourceWithWaitSupport

Constructors

ContainerResource(String, String)

A resource that represents a specified container.

Properties

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

Extension Methods

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.

Applies to

Share via