MongoDBDatabaseResource Class

Reference

Definition

Namespace:: Aspire.Hosting.ApplicationModel

Assembly:: Aspire.Hosting.MongoDB.dll

Package:: Aspire.Hosting.MongoDB v8.2.0

Package:: Aspire.Hosting.MongoDB v9.0.0

Source:: MongoDBDatabaseResource.cs

Source:: MongoDBDatabaseResource.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 MongoDB database. This is a child resource of a MongoDBServerResource.

public class MongoDBDatabaseResource : Aspire.Hosting.ApplicationModel.Resource, Aspire.Hosting.ApplicationModel.IResourceWithConnectionString, Aspire.Hosting.ApplicationModel.IResourceWithParent<Aspire.Hosting.ApplicationModel.MongoDBServerResource>

type MongoDBDatabaseResource = class
    inherit Resource
    interface IResourceWithParent<MongoDBServerResource>
    interface IResourceWithParent
    interface IResource
    interface IResourceWithConnectionString
    interface IManifestExpressionProvider
    interface IValueProvider
    interface IValueWithReferences

Public Class MongoDBDatabaseResource
Inherits Resource
Implements IResourceWithConnectionString, IResourceWithParent(Of MongoDBServerResource)

Inheritance: Object

Resource
MongoDBDatabaseResource

Implements: IManifestExpressionProvider IResource IResourceWithConnectionString IResourceWithParent IResourceWithParent<MongoDBServerResource> IValueProvider IValueWithReferences

Constructors

MongoDBDatabaseResource(String, String, MongoDBServerResource)

A resource that represents a MongoDB database. This is a child resource of a MongoDBServerResource.

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
ConnectionStringExpression	Gets the connection string expression for the MongoDB database.
DatabaseName	Gets the database name.
Name	Gets the name of the resource. (Inherited from Resource)
Parent	Gets the parent MongoDB container resource.

Extension Methods

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