AzureCosmosDBResource Class

Reference

Definition

Namespace:: Aspire.Hosting

Assembly:: Aspire.Hosting.Azure.CosmosDB.dll

Package:: Aspire.Hosting.Azure.CosmosDB v8.2.0

Source:: AzureCosmosDBResource.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 an Azure Cosmos DB.

public class AzureCosmosDBResource : Aspire.Hosting.AzureConstructResource, Aspire.Hosting.ApplicationModel.IResourceWithConnectionString, Aspire.Hosting.ApplicationModel.IResourceWithEndpoints

type AzureCosmosDBResource = class
    inherit AzureConstructResource
    interface IResourceWithConnectionString
    interface IResource
    interface IManifestExpressionProvider
    interface IValueProvider
    interface IValueWithReferences
    interface IResourceWithEndpoints

Public Class AzureCosmosDBResource
Inherits AzureConstructResource
Implements IResourceWithConnectionString, IResourceWithEndpoints

Inheritance: Object

Resource

AzureBicepResource

AzureConstructResource
AzureCosmosDBResource

Implements: IManifestExpressionProvider IResource IResourceWithConnectionString IResourceWithEndpoints IValueProvider IValueWithReferences

Constructors

AzureCosmosDBResource(String, Action<ResourceModuleConstruct>)

A resource that represents an Azure Cosmos DB.

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
ConfigureConstruct	Callback for configuring construct. (Inherited from AzureConstructResource)
ConnectionString	Gets the "connectionString" reference from the secret outputs of the Azure Cosmos DB resource.
ConnectionStringExpression	Gets the connection string template for the manifest for the Azure Cosmos DB resource.
IsEmulator	Gets a value indicating whether the Azure Cosmos DB resource is running in the local emulator.
Name	Gets the name of the resource. (Inherited from Resource)
Outputs	Outputs that will be generated by the bicep template. (Inherited from AzureBicepResource)
Parameters	Parameters that will be passed into the bicep template. (Inherited from AzureBicepResource)
ProvisioningTaskCompletionSource	The task completion source for the provisioning operation. (Inherited from AzureBicepResource)
SecretOutputs	Secret outputs that will be generated by the bicep template. (Inherited from AzureBicepResource)

Methods

GetBicepTemplateFile(String, Boolean)	Gets the path to the bicep file. If the template is a string or embedded resource, it will be written to a temporary file. (Inherited from AzureConstructResource)
GetBicepTemplateString()	Get the bicep template as a string. Does not write to disk. (Inherited from AzureConstructResource)
WriteToManifest(ManifestPublishingContext)	Writes the resource to the manifest. (Inherited from AzureBicepResource)

Extension Methods

GetEndpoint(IResourceWithEndpoints, String)	Gets an endpoint reference for the specified endpoint name.
GetEndpoints(IResourceWithEndpoints)	Gets the endpoints for the specified resource.
GetReplicaCount(IResource)	Gets the number of replicas for the specified resource. Defaults to `1` if no ReplicaAnnotation is found.
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