ExistingAzureResourceExtensions Methods

AsExisting(IResourceBuilder<T>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<T>

Marks the resource as an existing resource in both run and publish modes.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> AsExisting<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<ParameterResource> nameParameter,
        IResourceBuilder<ParameterResource>? resourceGroupParameter)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L162-L164

Parameters

builderIResourceBuilder<T>The resource builder.

nameParameterIResourceBuilder<ParameterResource>The name of the existing resource.

resourceGroupParameterIResourceBuilder<ParameterResource>The name of the existing resource group, or null to use the current resource group.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

AsExistingInResourceGroup(IResourceBuilder<T>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)

extensionIResourceBuilder<T>

Marks the resource as an existing resource in a specific resource group and subscription in both run and publish modes.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> AsExistingInResourceGroup<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<ParameterResource> nameParameter,
        IResourceBuilder<ParameterResource> resourceGroupParameter,
        IResourceBuilder<ParameterResource> subscriptionParameter)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L492-L494

Parameters

builderIResourceBuilder<T>The resource builder.

nameParameterIResourceBuilder<ParameterResource>The name of the existing resource.

resourceGroupParameterIResourceBuilder<ParameterResource>The name of the existing resource group.

subscriptionParameterIResourceBuilder<ParameterResource>The subscription identifier containing the resource group.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

AsExistingInResourceGroup(IResourceBuilder<T>, string, string, string)extensionIResourceBuilder<T>

Marks the resource as an existing resource in a specific resource group and subscription in both run and publish modes.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> AsExistingInResourceGroup<T>(
        this IResourceBuilder<T> builder,
        string name,
        string resourceGroup,
        string subscription)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L510-L512

Parameters

builderIResourceBuilder<T>The resource builder.

namestringThe name of the existing resource.

resourceGroupstringThe name of the existing resource group.

subscriptionstringThe subscription identifier containing the resource group.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

AsExistingInSubscription(IResourceBuilder<T>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<T>

Marks the subscription-scoped resource as an existing resource in both run and publish modes.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> AsExistingInSubscription<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<ParameterResource> nameParameter,
        IResourceBuilder<ParameterResource> subscriptionParameter)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L315-L317

Parameters

builderIResourceBuilder<T>The resource builder.

nameParameterIResourceBuilder<ParameterResource>The name of the existing resource.

subscriptionParameterIResourceBuilder<ParameterResource>The subscription identifier containing the resource.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

Remarks

Use this only for Azure resources that are deployed at subscription scope. Most Azure services are resource-group scoped and should use AsExistingInResourceGroup.

AsExistingInSubscription(IResourceBuilder<T>, string, string)extensionIResourceBuilder<T>

Marks the subscription-scoped resource as an existing resource in both run and publish modes.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> AsExistingInSubscription<T>(
        this IResourceBuilder<T> builder,
        string name,
        string subscription)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L333-L335

Parameters

builderIResourceBuilder<T>The resource builder.

namestringThe name of the existing resource.

subscriptionstringThe subscription identifier containing the resource.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

Remarks

Use this only for Azure resources that are deployed at subscription scope. Most Azure services are resource-group scoped and should use AsExistingInResourceGroup.

AsExistingInTenant(IResourceBuilder<T>, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<T>

Marks the current-tenant-scoped resource as an existing resource in both run and publish modes.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> AsExistingInTenant<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<ParameterResource> nameParameter)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L655-L657

Parameters

builderIResourceBuilder<T>The resource builder.

nameParameterIResourceBuilder<ParameterResource>The name of the existing resource.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

Remarks

Tenant scope targets the current tenant. Bicep doesn't support selecting a different tenant with the tenant() scope function.

AsExistingInTenant(IResourceBuilder<T>, string)extensionIResourceBuilder<T>

Marks the current-tenant-scoped resource as an existing resource in both run and publish modes.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> AsExistingInTenant<T>(
        this IResourceBuilder<T> builder,
        string name)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L672-L674

Parameters

builderIResourceBuilder<T>The resource builder.

namestringThe name of the existing resource.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

Remarks

Tenant scope targets the current tenant. Bicep doesn't support selecting a different tenant with the tenant() scope function.

IsExisting(IResource)extensionbool

Determines if the resource is an existing resource.

public static class ExistingAzureResourceExtensions
{
    public static bool IsExisting(
        this IResource resource)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L24-L26

Parameters

resourceIResourceThe resource to check.

Returns

boolTrue if the resource is an existing resource, otherwise false.

Remarks

This method is not available in polyglot AppHosts. Use the Azure resource-specific polyglot surface instead.

PublishAsExisting(IResourceBuilder<T>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<T>

Marks the resource as an existing resource when the application is deployed.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> PublishAsExisting<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<ParameterResource> nameParameter,
        IResourceBuilder<ParameterResource>? resourceGroupParameter)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L107-L109

Parameters

builderIResourceBuilder<T>The resource builder.

nameParameterIResourceBuilder<ParameterResource>The name of the existing resource.

resourceGroupParameterIResourceBuilder<ParameterResource>The name of the existing resource group, or null to use the current resource group.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

PublishAsExisting(IResourceBuilder<T>, string, string?)extensionIResourceBuilder<T>

Marks the resource as an existing resource when the application is deployed.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> PublishAsExisting<T>(
        this IResourceBuilder<T> builder,
        string name,
        string? resourceGroup)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L124-L126

Parameters

builderIResourceBuilder<T>The resource builder.

namestringThe name of the existing resource.

resourceGroupstring?The name of the existing resource group, or null to use the current resource group.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

PublishAsExistingInResourceGroup(IResourceBuilder<T>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)

extensionIResourceBuilder<T>

Marks the resource as an existing resource in a specific resource group and subscription when the application is deployed.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> PublishAsExistingInResourceGroup<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<ParameterResource> nameParameter,
        IResourceBuilder<ParameterResource> resourceGroupParameter,
        IResourceBuilder<ParameterResource> subscriptionParameter)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L432-L434

Parameters

builderIResourceBuilder<T>The resource builder.

nameParameterIResourceBuilder<ParameterResource>The name of the existing resource.

resourceGroupParameterIResourceBuilder<ParameterResource>The name of the existing resource group.

subscriptionParameterIResourceBuilder<ParameterResource>The subscription identifier containing the resource group.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

PublishAsExistingInResourceGroup(IResourceBuilder<T>, string, string, string)extensionIResourceBuilder<T>

Marks the resource as an existing resource in a specific resource group and subscription when the application is deployed.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> PublishAsExistingInResourceGroup<T>(
        this IResourceBuilder<T> builder,
        string name,
        string resourceGroup,
        string subscription)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L450-L452

Parameters

builderIResourceBuilder<T>The resource builder.

namestringThe name of the existing resource.

resourceGroupstringThe name of the existing resource group.

subscriptionstringThe subscription identifier containing the resource group.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

PublishAsExistingInSubscription(IResourceBuilder<T>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)

extensionIResourceBuilder<T>

Marks the subscription-scoped resource as an existing resource when the application is deployed.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> PublishAsExistingInSubscription<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<ParameterResource> nameParameter,
        IResourceBuilder<ParameterResource> subscriptionParameter)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L258-L260

Parameters

builderIResourceBuilder<T>The resource builder.

nameParameterIResourceBuilder<ParameterResource>The name of the existing resource.

subscriptionParameterIResourceBuilder<ParameterResource>The subscription identifier containing the resource.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

Remarks

Use this only for Azure resources that are deployed at subscription scope. Most Azure services are resource-group scoped and should use PublishAsExistingInResourceGroup.

PublishAsExistingInSubscription(IResourceBuilder<T>, string, string)extensionIResourceBuilder<T>

Marks the subscription-scoped resource as an existing resource when the application is deployed.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> PublishAsExistingInSubscription<T>(
        this IResourceBuilder<T> builder,
        string name,
        string subscription)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L276-L278

Parameters

builderIResourceBuilder<T>The resource builder.

namestringThe name of the existing resource.

subscriptionstringThe subscription identifier containing the resource.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

Remarks

Use this only for Azure resources that are deployed at subscription scope. Most Azure services are resource-group scoped and should use PublishAsExistingInResourceGroup.

PublishAsExistingInTenant(IResourceBuilder<T>, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<T>

Marks the current-tenant-scoped resource as an existing resource when the application is deployed.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> PublishAsExistingInTenant<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<ParameterResource> nameParameter)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L603-L605

Parameters

builderIResourceBuilder<T>The resource builder.

nameParameterIResourceBuilder<ParameterResource>The name of the existing resource.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

Remarks

Tenant scope targets the current tenant. Bicep doesn't support selecting a different tenant with the tenant() scope function.

PublishAsExistingInTenant(IResourceBuilder<T>, string)extensionIResourceBuilder<T>

Marks the current-tenant-scoped resource as an existing resource when the application is deployed.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> PublishAsExistingInTenant<T>(
        this IResourceBuilder<T> builder,
        string name)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L620-L622

Parameters

builderIResourceBuilder<T>The resource builder.

namestringThe name of the existing resource.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

Remarks

Tenant scope targets the current tenant. Bicep doesn't support selecting a different tenant with the tenant() scope function.

RunAsExisting(IResourceBuilder<T>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<T>

Marks the resource as an existing resource when the application is running.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> RunAsExisting<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<ParameterResource> nameParameter,
        IResourceBuilder<ParameterResource>? resourceGroupParameter)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L52-L54

Parameters

builderIResourceBuilder<T>The resource builder.

nameParameterIResourceBuilder<ParameterResource>The name of the existing resource.

resourceGroupParameterIResourceBuilder<ParameterResource>The name of the existing resource group, or null to use the current resource group.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

RunAsExisting(IResourceBuilder<T>, string, string?)extensionIResourceBuilder<T>

Marks the resource as an existing resource when the application is running.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> RunAsExisting<T>(
        this IResourceBuilder<T> builder,
        string name,
        string? resourceGroup)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L69-L71

Parameters

builderIResourceBuilder<T>The resource builder.

namestringThe name of the existing resource.

resourceGroupstring?The name of the existing resource group, or null to use the current resource group.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

RunAsExistingInResourceGroup(IResourceBuilder<T>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)

extensionIResourceBuilder<T>

Marks the resource as an existing resource in a specific resource group and subscription when the application is running.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> RunAsExistingInResourceGroup<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<ParameterResource> nameParameter,
        IResourceBuilder<ParameterResource> resourceGroupParameter,
        IResourceBuilder<ParameterResource> subscriptionParameter)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L372-L374

Parameters

builderIResourceBuilder<T>The resource builder.

nameParameterIResourceBuilder<ParameterResource>The name of the existing resource.

resourceGroupParameterIResourceBuilder<ParameterResource>The name of the existing resource group.

subscriptionParameterIResourceBuilder<ParameterResource>The subscription identifier containing the resource group.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

RunAsExistingInResourceGroup(IResourceBuilder<T>, string, string, string)extensionIResourceBuilder<T>

Marks the resource as an existing resource in a specific resource group and subscription when the application is running.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> RunAsExistingInResourceGroup<T>(
        this IResourceBuilder<T> builder,
        string name,
        string resourceGroup,
        string subscription)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L390-L392

Parameters

builderIResourceBuilder<T>The resource builder.

namestringThe name of the existing resource.

resourceGroupstringThe name of the existing resource group.

subscriptionstringThe subscription identifier containing the resource group.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

RunAsExistingInSubscription(IResourceBuilder<T>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)

extensionIResourceBuilder<T>

Marks the subscription-scoped resource as an existing resource when the application is running.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> RunAsExistingInSubscription<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<ParameterResource> nameParameter,
        IResourceBuilder<ParameterResource> subscriptionParameter)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L201-L203

Parameters

builderIResourceBuilder<T>The resource builder.

nameParameterIResourceBuilder<ParameterResource>The name of the existing resource.

subscriptionParameterIResourceBuilder<ParameterResource>The subscription identifier containing the resource.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

Remarks

Use this only for Azure resources that are deployed at subscription scope. Most Azure services are resource-group scoped and should use RunAsExistingInResourceGroup.

RunAsExistingInSubscription(IResourceBuilder<T>, string, string)extensionIResourceBuilder<T>

Marks the subscription-scoped resource as an existing resource when the application is running.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> RunAsExistingInSubscription<T>(
        this IResourceBuilder<T> builder,
        string name,
        string subscription)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L219-L221

Parameters

builderIResourceBuilder<T>The resource builder.

namestringThe name of the existing resource.

subscriptionstringThe subscription identifier containing the resource.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

Remarks

Use this only for Azure resources that are deployed at subscription scope. Most Azure services are resource-group scoped and should use RunAsExistingInResourceGroup.

RunAsExistingInTenant(IResourceBuilder<T>, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<T>

Marks the current-tenant-scoped resource as an existing resource when the application is running.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> RunAsExistingInTenant<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<ParameterResource> nameParameter)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L551-L553

Parameters

builderIResourceBuilder<T>The resource builder.

nameParameterIResourceBuilder<ParameterResource>The name of the existing resource.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

Remarks

Tenant scope targets the current tenant. Bicep doesn't support selecting a different tenant with the tenant() scope function.

RunAsExistingInTenant(IResourceBuilder<T>, string)extensionIResourceBuilder<T>

Marks the current-tenant-scoped resource as an existing resource when the application is running.

public static class ExistingAzureResourceExtensions
{
    public static IResourceBuilder<T> RunAsExistingInTenant<T>(
        this IResourceBuilder<T> builder,
        string name)
    {
        // ...
    }
}

ExistingAzureResourceExtensions.cs#L568-L570

Parameters

builderIResourceBuilder<T>The resource builder.

namestringThe name of the existing resource.

Returns

IResourceBuilder<T>The resource builder with the existing resource annotation added.

Remarks

Tenant scope targets the current tenant. Bicep doesn't support selecting a different tenant with the tenant() scope function.