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

Package:: Aspire.Hosting.Azure v9.1.0

Package:: Aspire.Hosting.Azure v9.2.0

Package:: Aspire.Hosting.Azure v9.3.0

Source:: AzureBicepResource.cs

Source:: AzureBicepResource.cs

Source:: AzureBicepResource.cs

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

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

type AzureBicepResource = class
    inherit Resource
    interface IAzureResource
    interface IResource

type AzureBicepResource = class
    inherit Resource
    interface IAzureResource
    interface IResource
    interface IResourceWithParameters

Public Class AzureBicepResource
Inherits Resource
Implements IAzureResource

Public Class AzureBicepResource
Inherits Resource
Implements IAzureResource, IResourceWithParameters

Inheritance: Object

Resource
AzureBicepResource

Derived: Aspire.Hosting.Azure.AzureProvisioningResource

Aspire.Hosting.AzureConstructResource

Implements: IAzureResource IResource IResourceWithParameters

Constructors

AzureBicepResource(String, String, String, String)

Initializes a new instance of the AzureBicepResource class.

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.
Scope	The scope of the resource that will be configured in the main Bicep file.
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.

Explicit Interface Implementations

IResourceWithParameters.Parameters

Extension Methods

GetDeploymentTargetAnnotation(IResource, IComputeEnvironmentResource)	Gets the deployment target for the specified resource, if any. Throws an exception if there are multiple compute environments and a compute environment is not explicitly specified.
GetReplicaCount(IResource)	Gets the number of replicas for the specified resource. Defaults to `1` if no ReplicaAnnotation is found.
HasAnnotationIncludingAncestorsOfType<T>(IResource)	Gets whether `resource` or its ancestors have an annotation of type `T`
HasAnnotationOfType<T>(IResource)	Gets whether `resource` has an annotation of type `T`
ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, String, CancellationToken)	Processes argument values for the specified resource in the given execution context.
ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, String, CancellationToken)	Processes environment variable values for the specified resource within the given execution context.
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.
TryGetUrls(IResource, IEnumerable<ResourceUrlAnnotation>)	Attempts to retrieve the URLs for the given resource.
GetBicepIdentifier(IAzureResource)	Gets the Bicep identifier for the Azure resource.
IsContainer(IResource)	Determines whether the specified resource is a container resource.
IsExisting(IResource)	Determines if the resource is an existing resource.

Applies to

Share via