Aspire.Hosting.Azure.PostgreSQL
Official
📦 Aspire.Hosting.Azure.PostgreSQL v13.2.0 57 Functions
20 Types
20 types and 29 members
Types
handle
AzureBicepResource 9 members handle
AzureEnvironmentResource 2 members handle
AzureKeyVaultResource 5 members handle
AzureKeyVaultSecretResource handle
AzurePostgresFlexibleServerDatabaseResource 1 members handle
AzurePostgresFlexibleServerResource 4 members handle
AzureProvisioningResource 1 members handle
AzureResourceInfrastructure 3 members handle
AzureUserAssignedIdentityResource handle
BicepOutputReference 3 members interface
IAzureKeyVaultResource interface
IAzureKeyVaultSecretReference interface
IAzureResource 9 members handle
PgAdminContainerResource 1 members handle
PgWebContainerResource 1 members handle
PostgresDatabaseResource 8 members handle
PostgresMcpContainerResource handle
PostgresServerResource 26 members Functions
method
addAzureEnvironment builder Adds the shared Azure environment resource to the application model
addAzureEnvironment(): AzureEnvironmentResource method
addAzureInfrastructure builder Adds an Azure provisioning resource to the application model
addAzureInfrastructure(name: string, configureInfrastructure: (obj: AzureResourceInfrastructure) => Promise<void>): AzureProvisioningResource method
addAzureKeyVault builder Adds an Azure Key Vault resource
addAzureKeyVault(name: string): AzureKeyVaultResource method
addAzurePostgresFlexibleServer builder Adds an Azure PostgreSQL Flexible Server resource
addAzurePostgresFlexibleServer(name: string): AzurePostgresFlexibleServerResource method
addAzureProvisioning Adds Azure provisioning services to the distributed application builder
addAzureProvisioning(): IDistributedApplicationBuilder method
addAzureUserAssignedIdentity builder Adds an Azure user-assigned identity resource
addAzureUserAssignedIdentity(name: string): AzureUserAssignedIdentityResource method
addBicepTemplate builder Adds an Azure Bicep template resource from a file
addBicepTemplate(name: string, bicepFile: string): AzureBicepResource method
addBicepTemplateString builder Adds an Azure Bicep template resource from inline Bicep content
addBicepTemplateString(name: string, bicepContent: string): AzureBicepResource method
addDatabase builder Adds an Azure PostgreSQL database
addDatabase(name: string, databaseName?: string): AzurePostgresFlexibleServerDatabaseResource method
addDatabase builder Adds a PostgreSQL database
addDatabase(name: string, databaseName?: string): PostgresDatabaseResource method
addPostgres builder Adds a PostgreSQL server resource
addPostgres(name: string, userName?: ParameterResource, password?: ParameterResource, port?: number): PostgresServerResource method
addSecret builder Adds a secret to the Azure Key Vault from a parameter resource
addSecret(name: string, parameterResource: ParameterResource): AzureKeyVaultSecretResource method
addSecretFromExpression builder Adds a secret to the Azure Key Vault from a reference expression
addSecretFromExpression(name: string, value: ReferenceExpression): AzureKeyVaultSecretResource method
addSecretWithName builder Adds a named secret to the Azure Key Vault from a parameter resource
addSecretWithName(name: string, secretName: string, parameterResource: ParameterResource): AzureKeyVaultSecretResource method
addSecretWithNameFromExpression builder Adds a named secret to the Azure Key Vault from a reference expression
addSecretWithNameFromExpression(name: string, secretName: string, value: ReferenceExpression): AzureKeyVaultSecretResource method
asExisting builder Marks an Azure resource as existing in both run and publish modes by using parameter resources
asExisting(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource method
clearDefaultRoleAssignments builder Clears the default Azure role assignments from a resource
clearDefaultRoleAssignments(): IAzureResource method
configureInfrastructure builder Configures the Azure provisioning infrastructure callback
configureInfrastructure(configure: (obj: AzureResourceInfrastructure) => Promise<void>): AzureProvisioningResource method
getBicepIdentifier Gets the normalized Bicep identifier for an Azure resource
getBicepIdentifier(): string method
getOutput Gets an output reference from an Azure Bicep template resource
getOutput(name: string): BicepOutputReference method
getSecret Gets a secret reference from the Azure Key Vault
getSecret(secretName: string): IAzureKeyVaultSecretReference method
isExisting Determines whether a resource is marked as existing
isExisting(): boolean method
publishAsConnectionString builder Publishes an Azure resource to the manifest as a connection string
publishAsConnectionString(): IAzureResource method
publishAsExisting builder Marks an Azure resource as existing in publish mode
publishAsExisting(name: string, resourceGroup: string): IAzureResource method
publishAsExistingFromParameters builder Marks an Azure resource as existing in publish mode by using parameter resources
publishAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource method
runAsContainer builder Configures the Azure PostgreSQL Flexible Server resource to run locally in a container
runAsContainer(configureContainer?: (obj: PostgresServerResource) => Promise<void>): AzurePostgresFlexibleServerResource method
runAsExisting builder Marks an Azure resource as existing in run mode
runAsExisting(name: string, resourceGroup: string): IAzureResource method
runAsExistingFromParameters builder Marks an Azure resource as existing in run mode by using parameter resources
runAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource method
withAzureUserAssignedIdentity builder Associates an Azure user-assigned identity with a compute resource
withAzureUserAssignedIdentity(identityResourceBuilder: AzureUserAssignedIdentityResource): IComputeResource method
withCreationScript builder Defines the SQL script for database creation
withCreationScript(script: string): PostgresDatabaseResource method
withDataBindMount builder Adds a data bind mount for PostgreSQL
withDataBindMount(source: string, isReadOnly?: boolean): PostgresServerResource method
withDataVolume builder Adds a data volume for PostgreSQL
withDataVolume(name?: string, isReadOnly?: boolean): PostgresServerResource method
withEnvironmentFromKeyVaultSecret builder Sets an environment variable from an Azure Key Vault secret reference
withEnvironmentFromKeyVaultSecret(name: string, secretReference: IAzureKeyVaultSecretReference): IResourceWithEnvironment method
withEnvironmentFromOutput builder Sets an environment variable from a Bicep output reference
withEnvironmentFromOutput(name: string, bicepOutputReference: BicepOutputReference): IResourceWithEnvironment method
withHostPort builder Sets the host port for pgAdmin
withHostPort(port: number): PgAdminContainerResource method
withHostPort builder Sets the host port for pgweb
withHostPort(port: number): PgWebContainerResource method
withHostPort builder Sets the host port for PostgreSQL
withHostPort(port: number): PostgresServerResource method
withInitFiles builder Copies init files to PostgreSQL
withInitFiles(source: string): PostgresServerResource method
withKeyVaultRoleAssignments builder Assigns Key Vault roles to a resource
withKeyVaultRoleAssignments(target: AzureKeyVaultResource, roles: AzureKeyVaultRole[]): IResource method
withLocation builder Sets the Azure location for the shared Azure environment resource
withLocation(location: ParameterResource): AzureEnvironmentResource method
withParameter builder Adds a Bicep parameter without a value
withParameter(name: string): AzureBicepResource method
withParameterFromConnectionString builder Adds a Bicep parameter from a connection string resource builder
withParameterFromConnectionString(name: string, value: IResourceWithConnectionString): AzureBicepResource method
withParameterFromEndpoint builder Adds a Bicep parameter from an endpoint reference
withParameterFromEndpoint(name: string, value: EndpointReference): AzureBicepResource method
withParameterFromOutput builder Adds a Bicep parameter from another Bicep output reference
withParameterFromOutput(name: string, value: BicepOutputReference): AzureBicepResource method
withParameterFromParameter builder Adds a Bicep parameter from a parameter resource builder
withParameterFromParameter(name: string, value: ParameterResource): AzureBicepResource method
withParameterFromReferenceExpression builder Adds a Bicep parameter from a reference expression
withParameterFromReferenceExpression(name: string, value: ReferenceExpression): AzureBicepResource method
withParameterStringValue builder Adds a Bicep parameter with a string value
withParameterStringValue(name: string, value: string): AzureBicepResource method
withParameterStringValues builder Adds a Bicep parameter with a string list value
withParameterStringValues(name: string, value: string[]): AzureBicepResource method
withPassword builder Configures the PostgreSQL password
withPassword(password: ParameterResource): PostgresServerResource method
withPasswordAuthentication builder Configures password authentication for Azure PostgreSQL Flexible Server
withPasswordAuthentication(userName?: ParameterResource, password?: ParameterResource): AzurePostgresFlexibleServerResource method
withPasswordAuthenticationWithKeyVault builder Configures password authentication using a specified Azure Key Vault resource
withPasswordAuthenticationWithKeyVault(keyVaultBuilder: IAzureKeyVaultResource, userName?: ParameterResource, password?: ParameterResource): AzurePostgresFlexibleServerResource method
withPgAdmin builder Adds pgAdmin 4 management UI
withPgAdmin(configureContainer?: (obj: PgAdminContainerResource) => Promise<void>, containerName?: string): PostgresServerResource method
withPgWeb builder Adds pgweb management UI
withPgWeb(configureContainer?: (obj: PgWebContainerResource) => Promise<void>, containerName?: string): PostgresServerResource method
withPostgresMcp builder Adds a Postgres MCP server container
withPostgresMcp(configureContainer?: (obj: PostgresMcpContainerResource) => Promise<void>, containerName?: string): AzurePostgresFlexibleServerDatabaseResource method
withPostgresMcp builder Adds Postgres MCP server
withPostgresMcp(configureContainer?: (obj: PostgresMcpContainerResource) => Promise<void>, containerName?: string): PostgresDatabaseResource method
withResourceGroup builder Sets the Azure resource group for the shared Azure environment resource
withResourceGroup(resourceGroup: ParameterResource): AzureEnvironmentResource method
withUserName builder Configures the PostgreSQL user name
withUserName(userName: ParameterResource): PostgresServerResource