Share via


AzureProvisioningResource Class

Definition

An Aspire resource that supports use of Azure Provisioning APIs to create Azure resources.

public class AzureProvisioningResource : Aspire.Hosting.Azure.AzureBicepResource
type AzureProvisioningResource = class
    inherit AzureBicepResource
Public Class AzureProvisioningResource
Inherits AzureBicepResource
Inheritance
AzureProvisioningResource
Derived

Constructors

AzureProvisioningResource(String, Action<AzureResourceInfrastructure>)

An Aspire resource that supports use of Azure Provisioning APIs to create Azure resources.

Properties

Annotations

Gets the annotations associated with the resource.

(Inherited from Resource)
ConfigureInfrastructure

Callback for configuring the Azure resources.

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)
ProvisioningBuildOptions

Gets or sets the ProvisioningBuildOptions which contains common settings and functionality for building Azure resources.

ProvisioningTaskCompletionSource

The task completion source for the provisioning operation.

(Inherited from AzureBicepResource)
Scope

The scope of the resource that will be configured in the main Bicep file.

(Inherited from AzureBicepResource)
SecretOutputs

Secret outputs that will be generated by the bicep template.

(Inherited from AzureBicepResource)

Methods

CreateExistingOrNewProvisionableResource<T>(AzureResourceInfrastructure, Func<String,BicepValue<String>,T>, Func<AzureResourceInfrastructure,T>)

Encapsulates the logic for creating an existing or new ProvisionableResource based on whether or not the ExistingAzureResourceAnnotation exists on the resource.

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.

(Inherited from AzureBicepResource)

Extension Methods

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

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.

IsExisting(IResource)

Determines if the resource is an existing resource.

Applies to