IAzureResource

Interface

📦 Aspire.Hosting.Azure v13.4.0

interface IAzureResource {
  asExisting(
      name: ParameterResource,
      resourceGroup?: ParameterResource): IAzureResource;
  clearDefaultRoleAssignments(): IAzureResource;
  getBicepIdentifier(): string;
  isExisting(): boolean;
  publishAsConnectionString(): IAzureResource;
  publishAsExisting(
      name: ParameterResource,
      resourceGroup?: ParameterResource): IAzureResource;
  runAsExisting(
      name: ParameterResource,
      resourceGroup?: ParameterResource): IAzureResource;
}

7 members

Methods

method asExisting builder

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

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

Parameters

name ParameterResource

resourceGroup ParameterResource optional

Returns

IAzureResource

method clearDefaultRoleAssignments builder

Clears all default role assignments for the specified Azure resource.

clearDefaultRoleAssignments(): IAzureResource

Returns

IAzureResource

method getBicepIdentifier

Gets the Bicep identifier for the Azure resource.

getBicepIdentifier(): string

Returns

string

method isExisting

Determines whether the Azure resource is marked as existing.

isExisting(): boolean

Returns

boolean

method publishAsConnectionString builder

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

publishAsConnectionString(): IAzureResource

Returns

IAzureResource

method publishAsExisting builder

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

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

Parameters

name ParameterResource

resourceGroup ParameterResource optional

Returns

IAzureResource

method runAsExisting builder

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

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

Parameters

name ParameterResource

resourceGroup ParameterResource optional

Returns

IAzureResource