AzureProvisioningResourceExtensions Methods

ClassMethods9 members

Extensions for working with AzureProvisioningResource and related types.

AddAzureInfrastructure(IDistributedApplicationBuilder, string, Action<AzureResourceInfrastructure>)extensionIResourceBuilder<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)
    {
        // ...
    }
}

AzureProvisioningResourceExtensions.cs#L27-L30

Parameters

builderIDistributedApplicationBuilderThe distributed application builder.

namestringThe name of the resource being added.

configureInfrastructureAction<AzureResourceInfrastructure>A callback used to configure the infrastructure resource.

Returns

IResourceBuilder<AzureProvisioningResource>A resource builder for the AzureProvisioningResource that can be used for further configuration.

AsKeyVaultSecret(IAzureKeyVaultSecretReference, AzureResourceInfrastructure)extensionKeyVaultSecret

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)
    {
        // ...
    }
}

AzureProvisioningResourceExtensions.cs#L69-L107

Parameters

secretReferenceIAzureKeyVaultSecretReferenceThe IAzureKeyVaultSecretReference representing the Key Vault secret to reference.

infrastructureAzureResourceInfrastructureThe AzureResourceInfrastructure in which to locate or add the KeyVault.KeyVaultSecret.

Returns

KeyVaultSecret The KeyVault.KeyVaultSecret instance corresponding to the given secret reference.

Remarks

This method is not available in polyglot app hosts.

AsProvisioningParameter(IResourceBuilder<ParameterResource>, AzureResourceInfrastructure, string?)extensionProvisioningParameter

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)
    {
        // ...
    }
}

AzureProvisioningResourceExtensions.cs#L131-L134

Parameters

parameterResourceBuilderIResourceBuilder<ParameterResource> The ApplicationModel.IResourceBuilder`1 that represents a parameter in the Hosting.ApplicationModel to get or create a corresponding Provisioning.ProvisioningParameter.

infrastructureAzureResourceInfrastructureThe AzureResourceInfrastructure that contains the Provisioning.ProvisioningParameter.

parameterNamestring?optionalThe name of the parameter to be assigned.

Returns

ProvisioningParameter The corresponding Provisioning.ProvisioningParameter that was found or newly created.

Remarks

This method is not available in polyglot app hosts.

AsProvisioningParameter(IManifestExpressionProvider, AzureResourceInfrastructure, string?, bool?)extensionProvisioningParameter

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)
    {
        // ...
    }
}

AzureProvisioningResourceExtensions.cs#L152-L159

Parameters

manifestExpressionProviderIManifestExpressionProviderThe ApplicationModel.IManifestExpressionProvider that represents the value to use for the Provisioning.ProvisioningParameter.

infrastructureAzureResourceInfrastructureThe AzureResourceInfrastructure that contains the Provisioning.ProvisioningParameter.

parameterNamestring?optionalThe name of the parameter to be assigned.

isSecurebool?optionalIndicates whether the parameter is secure.

Returns

ProvisioningParameter The corresponding Provisioning.ProvisioningParameter that was found or newly created.

Remarks

This method is not available in polyglot app hosts.

AsProvisioningParameter(ParameterResource, AzureResourceInfrastructure, string?)extensionProvisioningParameter

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)
    {
        // ...
    }
}

AzureProvisioningResourceExtensions.cs#L183-L190

Parameters

parameterResourceParameterResource The ApplicationModel.ParameterResource that represents a parameter in the Hosting.ApplicationModel to get or create a corresponding Provisioning.ProvisioningParameter.

infrastructureAzureResourceInfrastructureThe AzureResourceInfrastructure that contains the Provisioning.ProvisioningParameter.

parameterNamestring?optionalThe name of the parameter to be assigned.

Returns

ProvisioningParameter The corresponding Provisioning.ProvisioningParameter that was found or newly created.

Remarks

This method is not available in polyglot app hosts.

AsProvisioningParameter(BicepOutputReference, AzureResourceInfrastructure, string?)extensionProvisioningParameter

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)
    {
        // ...
    }
}

AzureProvisioningResourceExtensions.cs#L213-L220

Parameters

outputReferenceBicepOutputReference The BicepOutputReference that contains the value to use for the Provisioning.ProvisioningParameter.

infrastructureAzureResourceInfrastructureThe AzureResourceInfrastructure that contains the Provisioning.ProvisioningParameter.

parameterNamestring?optionalThe name of the parameter to be assigned.

Returns

ProvisioningParameter The corresponding Provisioning.ProvisioningParameter that was found or newly created.

Remarks

This method is not available in polyglot app hosts.

AsProvisioningParameter(EndpointReference, AzureResourceInfrastructure, string)extensionProvisioningParameter

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)
    {
        // ...
    }
}

AzureProvisioningResourceExtensions.cs#L241-L247

Parameters

endpointReferenceEndpointReference The ApplicationModel.EndpointReference to use for the value of the Provisioning.ProvisioningParameter.

infrastructureAzureResourceInfrastructureThe AzureResourceInfrastructure that contains the Provisioning.ProvisioningParameter.

parameterNamestringThe name of the parameter to be assigned.

Returns

ProvisioningParameter The corresponding Provisioning.ProvisioningParameter that was found or newly created.

Remarks

This method is not available in polyglot app hosts.

AsProvisioningParameter(ReferenceExpression, AzureResourceInfrastructure, string)extensionProvisioningParameter

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)
    {
        // ...
    }
}

AzureProvisioningResourceExtensions.cs#L268-L274

Parameters

expressionReferenceExpression The ApplicationModel.ReferenceExpression that represents the value to use for the Provisioning.ProvisioningParameter.

infrastructureAzureResourceInfrastructureThe AzureResourceInfrastructure that contains the Provisioning.ProvisioningParameter.

parameterNamestringThe name of the parameter to be assigned.

Returns

ProvisioningParameter The corresponding Provisioning.ProvisioningParameter that was found or newly created.

Remarks

This method is not available in polyglot app hosts.

ConfigureInfrastructure(IResourceBuilder<T>, Action<AzureResourceInfrastructure>)extensionIResourceBuilder<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)
    {
        // ...
    }
}

AzureProvisioningResourceExtensions.cs#L45-L49

Parameters

builderIResourceBuilder<T>The resource builder.

configureAction<AzureResourceInfrastructure>The configuration callback.

Returns

IResourceBuilder<T>The resource builder.