IAzureResource

Interface

📦 Aspire.Hosting.Azure v13.6.0

interface IAzureResource {
  asExisting(
      name: string | ParameterResource,
      resourceGroup?: string | ParameterResource): IAzureResource;
  asExistingInResourceGroup(
      name: string | ParameterResource,
      resourceGroup: string | ParameterResource,
      subscription: string | ParameterResource): IAzureResource;
  asExistingInSubscription(
      name: string | ParameterResource,
      subscription: string | ParameterResource): IAzureResource;
  asExistingInTenant(name: string | ParameterResource): IAzureResource;
  clearDefaultRoleAssignments(): IAzureResource;
  getBicepIdentifier(): string;
  isExisting(): boolean;
  publishAsConnectionString(): IAzureResource;
  publishAsExisting(
      name: string | ParameterResource,
      resourceGroup?: string | ParameterResource): IAzureResource;
  publishAsExistingInResourceGroup(
      name: string | ParameterResource,
      resourceGroup: string | ParameterResource,
      subscription: string | ParameterResource): IAzureResource;
  publishAsExistingInSubscription(
      name: string | ParameterResource,
      subscription: string | ParameterResource): IAzureResource;
  publishAsExistingInTenant(name: string | ParameterResource): IAzureResource;
  runAsExisting(
      name: string | ParameterResource,
      resourceGroup?: string | ParameterResource): IAzureResource;
  runAsExistingInResourceGroup(
      name: string | ParameterResource,
      resourceGroup: string | ParameterResource,
      subscription: string | ParameterResource): IAzureResource;
  runAsExistingInSubscription(
      name: string | ParameterResource,
      subscription: string | ParameterResource): IAzureResource;
  runAsExistingInTenant(name: string | ParameterResource): IAzureResource;
}

16 members

Methods

methodasExistingbuilder

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

asExisting(
    name: string | ParameterResource,
    resourceGroup?: string | ParameterResource): IAzureResource

Parameters

namestring | ParameterResource

resourceGroupstring | ParameterResourceoptional

Returns

IAzureResource

methodasExistingInResourceGroupbuilder

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

asExistingInResourceGroup(
    name: string | ParameterResource,
    resourceGroup: string | ParameterResource,
    subscription: string | ParameterResource): IAzureResource

Parameters

namestring | ParameterResource

resourceGroupstring | ParameterResource

subscriptionstring | ParameterResource

Returns

IAzureResource

methodasExistingInSubscriptionbuilder

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

asExistingInSubscription(
    name: string | ParameterResource,
    subscription: string | ParameterResource): IAzureResource

Parameters

namestring | ParameterResource

subscriptionstring | ParameterResource

Returns

IAzureResource

methodasExistingInTenantbuilder

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

asExistingInTenant(name: string | ParameterResource): IAzureResource

Parameters

namestring | ParameterResource

Returns

IAzureResource

methodclearDefaultRoleAssignmentsbuilder

Clears all default role assignments for the specified Azure resource.

clearDefaultRoleAssignments(): IAzureResource

Returns

IAzureResource

methodgetBicepIdentifier

Gets the Bicep identifier for the Azure resource.

getBicepIdentifier(): string

Returns

string

methodisExisting

Determines whether the Azure resource is marked as existing.

isExisting(): boolean

Returns

boolean

methodpublishAsConnectionStringbuilder

Changes the resource to be published as a connection string reference in the manifest.

publishAsConnectionString(): IAzureResource

Returns

IAzureResource

methodpublishAsExistingbuilder

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

publishAsExisting(
    name: string | ParameterResource,
    resourceGroup?: string | ParameterResource): IAzureResource

Parameters

namestring | ParameterResource

resourceGroupstring | ParameterResourceoptional

Returns

IAzureResource

methodpublishAsExistingInResourceGroupbuilder

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

publishAsExistingInResourceGroup(
    name: string | ParameterResource,
    resourceGroup: string | ParameterResource,
    subscription: string | ParameterResource): IAzureResource

Parameters

namestring | ParameterResource

resourceGroupstring | ParameterResource

subscriptionstring | ParameterResource

Returns

IAzureResource

methodpublishAsExistingInSubscriptionbuilder

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

publishAsExistingInSubscription(
    name: string | ParameterResource,
    subscription: string | ParameterResource): IAzureResource

Parameters

namestring | ParameterResource

subscriptionstring | ParameterResource

Returns

IAzureResource

methodpublishAsExistingInTenantbuilder

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

publishAsExistingInTenant(name: string | ParameterResource): IAzureResource

Parameters

namestring | ParameterResource

Returns

IAzureResource

methodrunAsExistingbuilder

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

runAsExisting(
    name: string | ParameterResource,
    resourceGroup?: string | ParameterResource): IAzureResource

Parameters

namestring | ParameterResource

resourceGroupstring | ParameterResourceoptional

Returns

IAzureResource

methodrunAsExistingInResourceGroupbuilder

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

runAsExistingInResourceGroup(
    name: string | ParameterResource,
    resourceGroup: string | ParameterResource,
    subscription: string | ParameterResource): IAzureResource

Parameters

namestring | ParameterResource

resourceGroupstring | ParameterResource

subscriptionstring | ParameterResource

Returns

IAzureResource

methodrunAsExistingInSubscriptionbuilder

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

runAsExistingInSubscription(
    name: string | ParameterResource,
    subscription: string | ParameterResource): IAzureResource

Parameters

namestring | ParameterResource

subscriptionstring | ParameterResource

Returns

IAzureResource

methodrunAsExistingInTenantbuilder

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

runAsExistingInTenant(name: string | ParameterResource): IAzureResource

Parameters

namestring | ParameterResource

Returns

IAzureResource