Skip to content
Docs Try Aspire

AzureProvisioningResourceExtensions Methods

Class Methods 9 members
Extensions for working with AzureProvisioningResource and related types.
AddAzureInfrastructure(IDistributedApplicationBuilder, string, Action<AzureResourceInfrastructure>) Section titled AddAzureInfrastructure(IDistributedApplicationBuilder, string, Action<AzureResourceInfrastructure>) extension IResourceBuilder<AzureProvisioningResource>
Adds an Azure provisioning resource to the application model.
public static class AzureProvisioningResourceExtensions
{
public static IResourceBuilder<AzureProvisioningResource> AddAzureInfrastructure(
this IDistributedApplicationBuilder builder,
string name,
Action<AzureResourceInfrastructure> configureInfrastructure)
{
// ...
}
}
builder IDistributedApplicationBuilder The distributed application builder.
name string The name of the resource being added.
configureInfrastructure Action<AzureResourceInfrastructure> A callback used to configure the infrastructure resource.
IResourceBuilder<AzureProvisioningResource> A resource builder for the AzureProvisioningResource that can be used for further configuration.
AsKeyVaultSecret(IAzureKeyVaultSecretReference, AzureResourceInfrastructure) Section titled AsKeyVaultSecret(IAzureKeyVaultSecretReference, AzureResourceInfrastructure) extension KeyVaultSecret
Gets or creates a KeyVault.KeyVaultSecret resource in the specified AzureResourceInfrastructure for the given IAzureKeyVaultSecretReference.

If the referenced Key Vault or secret does not already exist in the infrastructure, they will be created and added. This allows referencing secrets that are provisioned outside of the current deployment.

public static class AzureProvisioningResourceExtensions
{
public static KeyVaultSecret AsKeyVaultSecret(
this IAzureKeyVaultSecretReference secretReference,
AzureResourceInfrastructure infrastructure)
{
// ...
}
}
secretReference IAzureKeyVaultSecretReference The IAzureKeyVaultSecretReference representing the Key Vault secret to reference.
infrastructure AzureResourceInfrastructure The AzureResourceInfrastructure in which to locate or add the KeyVault.KeyVaultSecret.
KeyVaultSecret The KeyVault.KeyVaultSecret instance corresponding to the given secret reference.
This method is not available in polyglot app hosts.
AsProvisioningParameter(IResourceBuilder<ParameterResource>, AzureResourceInfrastructure, string?) Section titled AsProvisioningParameter(IResourceBuilder<ParameterResource>, AzureResourceInfrastructure, string?) extension ProvisioningParameter
Creates a new Provisioning.ProvisioningParameter in infrastructure, or reuses an existing bicep parameter if one with the same name already exists, that corresponds to parameterResourceBuilder.
public static class AzureProvisioningResourceExtensions
{
public static ProvisioningParameter AsProvisioningParameter(
this IResourceBuilder<ParameterResource> parameterResourceBuilder,
AzureResourceInfrastructure infrastructure,
string? parameterName = null)
{
// ...
}
}
parameterResourceBuilder IResourceBuilder<ParameterResource> The ApplicationModel.IResourceBuilder`1 that represents a parameter in the Hosting.ApplicationModel to get or create a corresponding Provisioning.ProvisioningParameter.
infrastructure AzureResourceInfrastructure The AzureResourceInfrastructure that contains the Provisioning.ProvisioningParameter.
parameterName string? optional The name of the parameter to be assigned.
ProvisioningParameter The corresponding Provisioning.ProvisioningParameter that was found or newly created.
This method is not available in polyglot app hosts.
AsProvisioningParameter(IManifestExpressionProvider, AzureResourceInfrastructure, string?, bool?) Section titled AsProvisioningParameter(IManifestExpressionProvider, AzureResourceInfrastructure, string?, bool?) extension ProvisioningParameter
Creates a new Provisioning.ProvisioningParameter in infrastructure, or reuses an existing bicep parameter if one with the same name already exists, that corresponds to the given manifestExpressionProvider.
public static class AzureProvisioningResourceExtensions
{
public static ProvisioningParameter AsProvisioningParameter(
this IManifestExpressionProvider manifestExpressionProvider,
AzureResourceInfrastructure infrastructure,
string? parameterName = null,
bool? isSecure = null)
{
// ...
}
}
manifestExpressionProvider IManifestExpressionProvider The ApplicationModel.IManifestExpressionProvider that represents the value to use for the Provisioning.ProvisioningParameter.
infrastructure AzureResourceInfrastructure The AzureResourceInfrastructure that contains the Provisioning.ProvisioningParameter.
parameterName string? optional The name of the parameter to be assigned.
isSecure bool? optional Indicates whether the parameter is secure.
ProvisioningParameter The corresponding Provisioning.ProvisioningParameter that was found or newly created.
This method is not available in polyglot app hosts.
AsProvisioningParameter(ParameterResource, AzureResourceInfrastructure, string?) Section titled AsProvisioningParameter(ParameterResource, AzureResourceInfrastructure, string?) extension ProvisioningParameter
Creates a new Provisioning.ProvisioningParameter in infrastructure, or reuses an existing bicep parameter if one with the same name already exists, that corresponds to parameterResource.
public static class AzureProvisioningResourceExtensions
{
public static ProvisioningParameter AsProvisioningParameter(
this ParameterResource parameterResource,
AzureResourceInfrastructure infrastructure,
string? parameterName = null)
{
// ...
}
}
parameterResource ParameterResource The ApplicationModel.ParameterResource that represents a parameter in the Hosting.ApplicationModel to get or create a corresponding Provisioning.ProvisioningParameter.
infrastructure AzureResourceInfrastructure The AzureResourceInfrastructure that contains the Provisioning.ProvisioningParameter.
parameterName string? optional The name of the parameter to be assigned.
ProvisioningParameter The corresponding Provisioning.ProvisioningParameter that was found or newly created.
This method is not available in polyglot app hosts.
AsProvisioningParameter(BicepOutputReference, AzureResourceInfrastructure, string?) Section titled AsProvisioningParameter(BicepOutputReference, AzureResourceInfrastructure, string?) extension ProvisioningParameter
Creates a new Provisioning.ProvisioningParameter in infrastructure, or reuses an existing bicep parameter if one with the same name already exists, that corresponds to outputReference.
public static class AzureProvisioningResourceExtensions
{
public static ProvisioningParameter AsProvisioningParameter(
this BicepOutputReference outputReference,
AzureResourceInfrastructure infrastructure,
string? parameterName = null)
{
// ...
}
}
outputReference BicepOutputReference The BicepOutputReference that contains the value to use for the Provisioning.ProvisioningParameter.
infrastructure AzureResourceInfrastructure The AzureResourceInfrastructure that contains the Provisioning.ProvisioningParameter.
parameterName string? optional The name of the parameter to be assigned.
ProvisioningParameter The corresponding Provisioning.ProvisioningParameter that was found or newly created.
This method is not available in polyglot app hosts.
AsProvisioningParameter(EndpointReference, AzureResourceInfrastructure, string) Section titled AsProvisioningParameter(EndpointReference, AzureResourceInfrastructure, string) extension ProvisioningParameter
Creates a new Provisioning.ProvisioningParameter in infrastructure, or reuses an existing bicep parameter if one with the same name already exists, that corresponds to endpointReference.
public static class AzureProvisioningResourceExtensions
{
public static ProvisioningParameter AsProvisioningParameter(
this EndpointReference endpointReference,
AzureResourceInfrastructure infrastructure,
string parameterName)
{
// ...
}
}
endpointReference EndpointReference The ApplicationModel.EndpointReference to use for the value of the Provisioning.ProvisioningParameter.
infrastructure AzureResourceInfrastructure The AzureResourceInfrastructure that contains the Provisioning.ProvisioningParameter.
parameterName string The name of the parameter to be assigned.
ProvisioningParameter The corresponding Provisioning.ProvisioningParameter that was found or newly created.
This method is not available in polyglot app hosts.
AsProvisioningParameter(ReferenceExpression, AzureResourceInfrastructure, string) Section titled AsProvisioningParameter(ReferenceExpression, AzureResourceInfrastructure, string) extension ProvisioningParameter
Creates a new Provisioning.ProvisioningParameter in infrastructure, or reuses an existing bicep parameter if one with the same name already exists, that corresponds to expression.
public static class AzureProvisioningResourceExtensions
{
public static ProvisioningParameter AsProvisioningParameter(
this ReferenceExpression expression,
AzureResourceInfrastructure infrastructure,
string parameterName)
{
// ...
}
}
expression ReferenceExpression The ApplicationModel.ReferenceExpression that represents the value to use for the Provisioning.ProvisioningParameter.
infrastructure AzureResourceInfrastructure The AzureResourceInfrastructure that contains the Provisioning.ProvisioningParameter.
parameterName string The name of the parameter to be assigned.
ProvisioningParameter The corresponding Provisioning.ProvisioningParameter that was found or newly created.
This method is not available in polyglot app hosts.
ConfigureInfrastructure(IResourceBuilder<T>, Action<AzureResourceInfrastructure>) Section titled ConfigureInfrastructure(IResourceBuilder<T>, Action<AzureResourceInfrastructure>) extension IResourceBuilder<T>
Configures the Azure provisioning resource Provisioning.Infrastructure.
public static class AzureProvisioningResourceExtensions
{
public static IResourceBuilder<T> ConfigureInfrastructure<T>(
this IResourceBuilder<T> builder,
Action<AzureResourceInfrastructure> configure)
{
// ...
}
}
builder IResourceBuilder<T> The resource builder.
configure Action<AzureResourceInfrastructure> The configuration callback.
IResourceBuilder<T> The resource builder.