Aspire.Hosting.Azure.Storage

Docs/Reference/Search TypeScript APIs/Aspire.Hosting.Azure.Storage

Aspire.Hosting.Azure.Storage

Docs Reference Search TypeScript APIs Aspire.Hosting.Azure.Storage

Official

📦 Aspire.Hosting.Azure.Storagev13.4.0

16Functions

10Types

Search types, functions, members in Aspire.Hosting.Azure.Storage...

enumhandlemethod

10 types and 0 membersClear filters

Types

handleAzureBlobStorageContainerResource

handleAzureBlobStorageResource

handleAzureDataLakeStorageFileSystemResource

handleAzureDataLakeStorageResource

handleAzureQueueStorageQueueResource

handleAzureQueueStorageResource

handleAzureStorageEmulatorResource6 members

handleAzureStorageResource8 members

handleAzureTableStorageResource

Functions

methodaddAzureStoragebuilder

Adds an Azure Storage resource to the application model. This resource can be used to create Azure blob, table, and queue resources.

addAzureStorage(name: string): AzureStorageResource

methodaddBlobContainerbuilder

Adds an Azure Blob Storage container resource

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

methodaddBlobsbuilder

Adds an Azure Blob Storage resource

addBlobs(name: string): AzureBlobStorageResource

methodaddDataLakebuilder

Adds an Azure Data Lake Storage resource

addDataLake(name: string): AzureDataLakeStorageResource

methodaddDataLakeFileSystembuilder

Adds an Azure Data Lake Storage file system resource

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

methodaddQueuebuilder

Adds an Azure Storage queue resource

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

methodaddQueuesbuilder

Adds an Azure Queue Storage resource

addQueues(name: string): AzureQueueStorageResource

methodaddTablesbuilder

Adds an Azure Table Storage resource

addTables(name: string): AzureTableStorageResource

methodrunAsEmulatorbuilder

Configures the Azure Storage resource to be emulated using Azurite

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

methodwithApiVersionCheckbuilder

Ensures the emulator checks that the requested API version is valid.

withApiVersionCheck(enable?: boolean): AzureStorageEmulatorResource

methodwithBlobPortbuilder

Modifies the host port that the storage emulator listens on for blob requests.

withBlobPort(port: number): AzureStorageEmulatorResource

methodwithDataBindMountbuilder

Adds a bind mount for the data folder to an Azure Storage emulator resource.

withDataBindMount(path?: string, isReadOnly?: boolean): AzureStorageEmulatorResource

methodwithDataVolumebuilder

Adds a named volume for the data folder to an Azure Storage emulator resource.

withDataVolume(name?: string, isReadOnly?: boolean): AzureStorageEmulatorResource

methodwithQueuePortbuilder

Modifies the host port that the storage emulator listens on for queue requests.

withQueuePort(port: number): AzureStorageEmulatorResource

methodwithStorageRoleAssignmentsbuilder

Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Storage account. This replaces the default role assignments for the resource.

withStorageRoleAssignments(target: AzureStorageResource, roles: AzureStorageRole[]): IResource

methodwithTablePortbuilder

Modifies the host port that the storage emulator listens on for table requests.

withTablePort(port: number): AzureStorageEmulatorResource

Enums

enumAzureStorageRole20 values