AzureStorageExtensions
Class static net8.0
Extension methods for adding Azure Storage resources to an application model.
namespace Aspire.Hosting;
public static class AzureStorageExtensions{ // ...} 17 members
Methods17
Section titled MethodsAddAzureStorage(IDistributedApplicationBuilder, string)extensionats exportIResourceBuilder<AzureStorageResource> Adds an Azure Storage resource to the application model. This resource can be used to create Azure blob, table, and queue resources.
AddBlobContainer(IResourceBuilder<AzureStorageResource>, string, string?)extensionats exportIResourceBuilder<AzureBlobStorageContainerResource> Creates a builder for the
AzureBlobStorageContainerResource which can be referenced to get the Azure Storage blob container endpoint for the storage account. AddBlobContainer(IResourceBuilder<AzureBlobStorageResource>, string, string?)extensionobsoleteIResourceBuilder<AzureBlobStorageContainerResource> Creates a builder for the
AzureBlobStorageContainerResource which can be referenced to get the Azure Storage blob container endpoint for the storage account. AddBlobs(IResourceBuilder<AzureStorageResource>, string)extensionats exportIResourceBuilder<AzureBlobStorageResource> Creates a builder for the
AzureBlobStorageResource which can be referenced to get the Azure Storage blob endpoint for the storage account. AddDataLake(IResourceBuilder<AzureStorageResource>, string)extensionats exportIResourceBuilder<AzureDataLakeStorageResource> Creates a builder for the
AzureDataLakeStorageResource which can be referenced to get the Azure Data Lake endpoint for the storage account. AddDataLakeFileSystem(IResourceBuilder<AzureStorageResource>, string, string?)extensionats exportIResourceBuilder<AzureDataLakeStorageFileSystemResource> Creates a builder for the
AzureDataLakeStorageFileSystemResource which can be referenced to get the Azure DataLake file system connection string. AddQueue(IResourceBuilder<AzureStorageResource>, string, string?)extensionats exportIResourceBuilder<AzureQueueStorageQueueResource> Creates a builder for the
AzureQueueStorageQueueResource which can be referenced to get the Azure Storage queue for the storage account. AddQueues(IResourceBuilder<AzureStorageResource>, string)extensionats exportIResourceBuilder<AzureQueueStorageResource> Creates a builder for the
AzureQueueStorageResource which can be referenced to get the Azure Storage queues endpoint for the storage account. AddTables(IResourceBuilder<AzureStorageResource>, string)extensionats exportIResourceBuilder<AzureTableStorageResource> Creates a builder for the
AzureTableStorageResource which can be referenced to get the Azure Storage tables endpoint for the storage account. RunAsEmulator(IResourceBuilder<AzureStorageResource>, Action<IResourceBuilder<AzureStorageEmulatorResource>>)extensionats exportIResourceBuilder<AzureStorageResource> Configures an Azure Storage resource to be emulated using Azurite. This resource requires an
AzureStorageResource to be added to the application model. WithApiVersionCheck(IResourceBuilder<AzureStorageEmulatorResource>, bool)extensionats exportIResourceBuilder<AzureStorageEmulatorResource> Ensures the emulator checks that the requested API version is valid.
WithBlobPort(IResourceBuilder<AzureStorageEmulatorResource>, int)extensionats exportIResourceBuilder<AzureStorageEmulatorResource> Modifies the host port that the storage emulator listens on for blob requests.
WithDataBindMount(IResourceBuilder<AzureStorageEmulatorResource>, string?, bool)extensionats exportIResourceBuilder<AzureStorageEmulatorResource> Adds a bind mount for the data folder to an Azure Storage emulator resource.
WithDataVolume(IResourceBuilder<AzureStorageEmulatorResource>, string?, bool)extensionats exportIResourceBuilder<AzureStorageEmulatorResource> Adds a named volume for the data folder to an Azure Storage emulator resource.
WithQueuePort(IResourceBuilder<AzureStorageEmulatorResource>, int)extensionats exportIResourceBuilder<AzureStorageEmulatorResource> Modifies the host port that the storage emulator listens on for queue requests.
WithRoleAssignments(IResourceBuilder<T>, IResourceBuilder<AzureStorageResource>, StorageBuiltInRole[])extensionats ignoredIResourceBuilder<T> 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.
WithTablePort(IResourceBuilder<AzureStorageEmulatorResource>, int)extensionats exportIResourceBuilder<AzureStorageEmulatorResource> Modifies the host port that the storage emulator listens on for table requests.