AzureStorageResource

Handle

📦 Aspire.Hosting.Azure.Storage v13.4.0

interface AzureStorageResource
  extends IAzureResource,
    IResource,
    IResourceWithEndpoints,
    IResourceWithParameters,
    IAzureNspAssociationTarget,
    IResourceWithAzureFunctionsConfig {
  addBlobContainer(
      name: string,
      blobContainerName?: string): AzureBlobStorageContainerResource;
  addBlobs(name: string): AzureBlobStorageResource;
  addDataLake(name: string): AzureDataLakeStorageResource;
  addDataLakeFileSystem(
      name: string,
      dataLakeFileSystemName?: string): AzureDataLakeStorageFileSystemResource;
  addQueue(
      name: string,
      queueName?: string): AzureQueueStorageQueueResource;
  addQueues(name: string): AzureQueueStorageResource;
  addTables(name: string): AzureTableStorageResource;
  runAsEmulator(configureContainer?: (obj: AzureStorageEmulatorResource) => Promise<void>): AzureStorageResource;
}

8 members

Methods

methodaddBlobContainerbuilder

Adds an Azure Blob Storage container resource

addBlobContainer(
    name: string,
    blobContainerName?: string): AzureBlobStorageContainerResource

Parameters

namestring

blobContainerNamestringoptional

Returns

AzureBlobStorageContainerResource

methodaddBlobsbuilder

Adds an Azure Blob Storage resource

addBlobs(name: string): AzureBlobStorageResource

Parameters

namestring

Returns

AzureBlobStorageResource

methodaddDataLakebuilder

Adds an Azure Data Lake Storage resource

addDataLake(name: string): AzureDataLakeStorageResource

Parameters

namestring

Returns

AzureDataLakeStorageResource

methodaddDataLakeFileSystembuilder

Adds an Azure Data Lake Storage file system resource

addDataLakeFileSystem(
    name: string,
    dataLakeFileSystemName?: string): AzureDataLakeStorageFileSystemResource

Parameters

namestring

dataLakeFileSystemNamestringoptional

Returns

AzureDataLakeStorageFileSystemResource

methodaddQueuebuilder

Adds an Azure Storage queue resource

addQueue(
    name: string,
    queueName?: string): AzureQueueStorageQueueResource

Parameters

namestring

queueNamestringoptional

Returns

AzureQueueStorageQueueResource

methodaddQueuesbuilder

Adds an Azure Queue Storage resource

addQueues(name: string): AzureQueueStorageResource

Parameters

namestring

Returns

AzureQueueStorageResource

methodaddTablesbuilder

Adds an Azure Table Storage resource

addTables(name: string): AzureTableStorageResource

Parameters

namestring

Returns

AzureTableStorageResource

methodrunAsEmulatorbuilder

Configures the Azure Storage resource to be emulated using Azurite

runAsEmulator(configureContainer?: (obj: AzureStorageEmulatorResource) => Promise<void>): AzureStorageResource

Parameters

configureContainer(obj: AzureStorageEmulatorResource) => Promise<void>optional

Returns

AzureStorageResource