AspireDataLakeExtensions Methods
ClassMethods4 members
Provides extension methods for registering
DataLake.DataLakeServiceClient as a singleton in the services provided by the Hosting.IHostApplicationBuilder. AddAzureDataLakeFileSystemClient(IHostApplicationBuilder, string, Action<AzureDataLakeFileSystemSettings>, Action<IAzureClientBuilder<DataLakeFileSystemClient, DataLakeClientOptions>>)Section titled AddAzureDataLakeFileSystemClient(IHostApplicationBuilder, string, Action<AzureDataLakeFileSystemSettings>, Action<IAzureClientBuilder<DataLakeFileSystemClient, DataLakeClientOptions>>)extension Registers
DataLake.DataLakeFileSystemClient as a singleton in the services provided by the builder. Enables retries, corresponding health check, logging and telemetry. public static class AspireDataLakeExtensions{ public static void AddAzureDataLakeFileSystemClient( this IHostApplicationBuilder builder, string connectionName, Action<AzureDataLakeFileSystemSettings>? configureSettings = null, Action<IAzureClientBuilder<DataLakeFileSystemClient, DataLakeClientOptions>>? configureClientBuilder = null) { // ... }}Parameters
builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder to read config from and add services to.connectionNamestringA name used to retrieve the connection string from the ConnectionStrings configuration section.configureSettingsAction<AzureDataLakeFileSystemSettings>optional An optional method that can be used for customizing the AzureDataLakeFileSystemSettings. It's invoked after the settings are read from the configuration. configureClientBuilderAction<IAzureClientBuilder<DataLakeFileSystemClient, DataLakeClientOptions>>optional An optional method that can be used for customizing the Extensions.IAzureClientBuilder`2. Exceptions
InvalidOperationException Neither AzureDataLakeSettings.ConnectionString nor AzureDataLakeSettings.ServiceUri is provided. - or - AzureDataLakeFileSystemSettings.FileSystemName is not provided in the configuration section. Remarks
Reads the configuration from "Aspire:Azure:Storage:Files:DataLake" section.
AddAzureDataLakeServiceClient(IHostApplicationBuilder, string, Action<AzureDataLakeSettings>, Action<IAzureClientBuilder<DataLakeServiceClient, DataLakeClientOptions>>)Section titled AddAzureDataLakeServiceClient(IHostApplicationBuilder, string, Action<AzureDataLakeSettings>, Action<IAzureClientBuilder<DataLakeServiceClient, DataLakeClientOptions>>)extension Registers
DataLake.DataLakeServiceClient as a singleton in the services provided by the builder. Enables retries, corresponding health check, logging and telemetry. public static class AspireDataLakeExtensions{ public static void AddAzureDataLakeServiceClient( this IHostApplicationBuilder builder, string connectionName, Action<AzureDataLakeSettings>? configureSettings = null, Action<IAzureClientBuilder<DataLakeServiceClient, DataLakeClientOptions>>? configureClientBuilder = null) { // ... }}Parameters
builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder to read config from and add services to.connectionNamestringA name used to retrieve the connection string from the ConnectionStrings configuration section.configureSettingsAction<AzureDataLakeSettings>optionalAn optional method that can be used for customizing the AzureDataLakeSettings. It's invoked after the settings are read from the configuration.configureClientBuilderAction<IAzureClientBuilder<DataLakeServiceClient, DataLakeClientOptions>>optionalAn optional method that can be used for customizing the Extensions.IAzureClientBuilder`2.Exceptions
InvalidOperationException Neither AzureDataLakeSettings.ConnectionString nor AzureDataLakeSettings.ServiceUri is provided. Remarks
Reads the configuration from "Aspire:Azure:Storage:Files:DataLake" section.
AddKeyedAzureDataLakeFileSystemClient(IHostApplicationBuilder, string, Action<AzureDataLakeFileSystemSettings>, Action<IAzureClientBuilder<DataLakeFileSystemClient, DataLakeClientOptions>>)Section titled AddKeyedAzureDataLakeFileSystemClient(IHostApplicationBuilder, string, Action<AzureDataLakeFileSystemSettings>, Action<IAzureClientBuilder<DataLakeFileSystemClient, DataLakeClientOptions>>)extension Registers
DataLake.DataLakeFileSystemClient as a singleton in the services provided by the builder. Enables retries, corresponding health check, logging and telemetry. public static class AspireDataLakeExtensions{ public static void AddKeyedAzureDataLakeFileSystemClient( this IHostApplicationBuilder builder, string name, Action<AzureDataLakeFileSystemSettings>? configureSettings = null, Action<IAzureClientBuilder<DataLakeFileSystemClient, DataLakeClientOptions>>? configureClientBuilder = null) { // ... }}Parameters
builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder to read config from and add services to.namestringA name used to retrieve the connection string from the ConnectionStrings configuration section.configureSettingsAction<AzureDataLakeFileSystemSettings>optional An optional method that can be used for customizing the AzureDataLakeFileSystemSettings. It's invoked after the settings are read from the configuration. configureClientBuilderAction<IAzureClientBuilder<DataLakeFileSystemClient, DataLakeClientOptions>>optional An optional method that can be used for customizing the Extensions.IAzureClientBuilder`2. Exceptions
InvalidOperationException Neither AzureDataLakeSettings.ConnectionString nor AzureDataLakeSettings.ServiceUri is provided. - or - AzureDataLakeFileSystemSettings.FileSystemName is not provided in the configuration section. Remarks
Reads the configuration from "Aspire:Azure:Storage:Files:DataLake" section.
AddKeyedAzureDataLakeServiceClient(IHostApplicationBuilder, string, Action<AzureDataLakeSettings>, Action<IAzureClientBuilder<DataLakeServiceClient, DataLakeClientOptions>>)Section titled AddKeyedAzureDataLakeServiceClient(IHostApplicationBuilder, string, Action<AzureDataLakeSettings>, Action<IAzureClientBuilder<DataLakeServiceClient, DataLakeClientOptions>>)extension Registers
DataLake.DataLakeServiceClient as a singleton for given name in the services provided by the builder. Enables retries, corresponding health check, logging and telemetry. public static class AspireDataLakeExtensions{ public static void AddKeyedAzureDataLakeServiceClient( this IHostApplicationBuilder builder, string name, Action<AzureDataLakeSettings>? configureSettings = null, Action<IAzureClientBuilder<DataLakeServiceClient, DataLakeClientOptions>>? configureClientBuilder = null) { // ... }}Parameters
builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder to read config from and add services to.namestring The name of the component, which is used as the ServiceDescriptor.ServiceKey of the service and also to retrieve the connection string from the ConnectionStrings configuration section. configureSettingsAction<AzureDataLakeSettings>optional An optional method that can be used for customizing the AzureDataLakeSettings. It's invoked after the settings are read from the configuration. configureClientBuilderAction<IAzureClientBuilder<DataLakeServiceClient, DataLakeClientOptions>>optional An optional method that can be used for customizing the Extensions.IAzureClientBuilder`2. Exceptions
InvalidOperationException Neither AzureDataLakeSettings.ConnectionString nor AzureDataLakeSettings.ServiceUri is provided. Remarks
Reads the configuration from "Aspire:Azure:Storage:Files:DataLake:{name}" section.