AzurePostgresResource Class

Definition

Namespace:

Aspire.Hosting.Azure

Assembly:

Aspire.Hosting.Azure.PostgreSQL.dll

Package:

Aspire.Hosting.Azure.PostgreSQL v13.1.0

Source:

AzurePostgresResource.cs

Caution

This class is obsolete and will be removed in a future version. Use AddAzurePostgresFlexibleServer instead to add an Azure Postgres Flexible Server resource.

Represents an resource for Azure Postgres Flexible Server.

[System.Obsolete("This class is obsolete and will be removed in a future version. Use AddAzurePostgresFlexibleServer instead to add an Azure Postgres Flexible Server resource.")]
public class AzurePostgresResource : Aspire.Hosting.Azure.AzureProvisioningResource, Aspire.Hosting.ApplicationModel.IResourceWithConnectionString

[<System.Obsolete("This class is obsolete and will be removed in a future version. Use AddAzurePostgresFlexibleServer instead to add an Azure Postgres Flexible Server resource.")>]
type AzurePostgresResource = class
    inherit AzureProvisioningResource
    interface IResourceWithConnectionString
    interface IResource
    interface IManifestExpressionProvider
    interface IValueProvider
    interface IValueWithReferences

Public Class AzurePostgresResource
Inherits AzureProvisioningResource
Implements IResourceWithConnectionString

Inheritance

Object

Resource

AzureBicepResource

AzureProvisioningResource

AzurePostgresResource

Attributes

ObsoleteAttribute

Implements

IManifestExpressionProvider IResource IResourceWithConnectionString IValueProvider IValueWithReferences

Constructors

Name	Description
AzurePostgresResource(PostgresServerResource, Action<AzureResourceInfrastructure>)	Represents an resource for Azure Postgres Flexible Server.

Properties

Name	Description
Annotations	Gets the annotations associated with the resource.
ConfigureInfrastructure	Callback for configuring the Azure resources. (Inherited from AzureProvisioningResource)
ConnectionString	Gets the "connectionString" secret output reference from the bicep template for the Azure Postgres Flexible Server.
ConnectionStringExpression	Gets the connection template for the manifest for the Azure Postgres Flexible Server.
Name	Gets the name of the 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. (Inherited from AzureProvisioningResource)
ProvisioningTaskCompletionSource	The task completion source for the provisioning operation. (Inherited from AzureBicepResource)
References	References to other objects that may contain Azure resource references. (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

Name	Description
AddAsExistingResource(AzureResourceInfrastructure)	Adds a new ProvisionableResource into infra. The new resource represents a reference to the current AzureProvisioningResource via https://learn.microsoft.com/azure/azure-resource-manager/bicep/existing-resource. (Inherited from AzureProvisioningResource)
AddRoleAssignments(IAddRoleAssignmentsContext)	Adds role assignments to this Azure resource. (Inherited from AzureProvisioningResource)
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 AzureProvisioningResource)
GetBicepTemplateString()	Get the bicep template as a string. Does not write to disk. (Inherited from AzureProvisioningResource)
WriteToManifest(ManifestPublishingContext)	Writes the resource to the manifest. (Inherited from AzureBicepResource)

Explicit Interface Implementations

Name	Description
IResourceWithParameters.Parameters	(Inherited from AzureBicepResource)

Extension Methods

Name	Description
AsEnvironmentPlaceholder(IManifestExpressionProvider, DockerComposeServiceResource)	Creates a placeholder for an environment variable in the Docker Compose file.
AsProvisioningParameter(IManifestExpressionProvider, AzureResourceInfrastructure, String, Nullable<Boolean>)	Creates a new ProvisioningParameter in infrastructure, or reuses an existing bicep parameter if one with
CombineProperties(IResourceWithConnectionString, IEnumerable<KeyValuePair<String,ReferenceExpression>>)	Combines two sets of connection properties, with properties from the additional set overriding those in the source set in case of key conflicts.
GetBicepIdentifier(IAzureResource)	Gets the Bicep identifier for the Azure resource.
GetConnectionProperty(IResourceWithConnectionString, String)	Retrieves the value of a specified connection property from the resource's connection properties.
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
IsContainer(IResource)	Determines whether the specified resource is a container resource.
IsEmulator(IResource)	Determines whether the specified resource is an emulator resource.
IsExcludedFromPublish(IResource)	Gets a value indicating whether the resource is excluded from being published.
IsExisting(IResource)	Determines if the resource is an existing resource.
ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, CancellationToken)	Obsolete. Processes argument values for the specified resource in the given execution context.
ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, CancellationToken)	Obsolete. Processes environment variable values for the specified resource within the given execution context.
RequiresImageBuild(IResource)	Determines whether the specified resource requires image building.
RequiresImageBuildAndPush(IResource)	Determines whether the specified resource requires image building and pushing.
ResolveEndpoints(IResource, IPortAllocator)	Resolves endpoint port configuration for the specified resource. Computes target ports and exposed ports based on resource type, endpoint configuration, and whether the endpoint is considered a default HTTP endpoint.
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, Boolean, String)	Attempts to get the container image name 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.