AzureBicepResource Class

Reference

Definition

Namespace:: Aspire.Hosting.Azure

Assembly:: Aspire.Hosting.Azure.dll

Package:: Aspire.Hosting.Azure v8.2.0

Package:: Aspire.Hosting.Azure v9.0.0

Source:: AzureBicepResource.cs

Source:: AzureBicepResource.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.

Represents an Azure Bicep resource.

public class AzureBicepResource : Aspire.Hosting.ApplicationModel.Resource, Aspire.Hosting.ApplicationModel.IAzureResource

type AzureBicepResource = class
    inherit Resource
    interface IAzureResource
    interface IResource

Public Class AzureBicepResource
Inherits Resource
Implements IAzureResource

Inheritance: Object

Resource
AzureBicepResource

Derived: Aspire.Hosting.Azure.AzureProvisioningResource

Aspire.Hosting.AzureConstructResource

Implements: IAzureResource IResource

Constructors

AzureBicepResource(String, String, String, String)

Represents an Azure Bicep resource.

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
Name	Gets the name of the resource. (Inherited from Resource)
Outputs	Outputs that will be generated by the bicep template.
Parameters	Parameters that will be passed into the bicep template.
ProvisioningTaskCompletionSource	The task completion source for the provisioning operation.
SecretOutputs	Secret outputs that will be generated by the bicep template.

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.
GetBicepTemplateString()	Get the bicep template as a string. Does not write to disk.
WriteToManifest(ManifestPublishingContext)	Writes the resource to the manifest.

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.
GetBicepIdentifier(IAzureResource)	Gets the Bicep identifier for the Azure resource.
IsContainer(IResource)	Determines whether the specified resource is a container resource.

Applies to

Share via