DataSource.AzureBlobStorage Method

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Service.dll

Package:

Microsoft.Azure.Search.Service v10.1.0

Source:

DataSource.Customization.cs

Creates a new DataSource to connect to an Azure Blob container.

public static Microsoft.Azure.Search.Models.DataSource AzureBlobStorage (string name, string storageConnectionString, string containerName, string pathPrefix = default, Microsoft.Azure.Search.Models.DataDeletionDetectionPolicy deletionDetectionPolicy = default, string description = default);

static member AzureBlobStorage : string * string * string * string * Microsoft.Azure.Search.Models.DataDeletionDetectionPolicy * string -> Microsoft.Azure.Search.Models.DataSource

Public Shared Function AzureBlobStorage (name As String, storageConnectionString As String, containerName As String, Optional pathPrefix As String = Nothing, Optional deletionDetectionPolicy As DataDeletionDetectionPolicy = Nothing, Optional description As String = Nothing) As DataSource

Parameters

name

String

The name of the datasource.

storageConnectionString

String

The connection string for the Azure Storage account. It must follow this format: "DefaultEndpointsProtocol=https;AccountName=[your storage account];AccountKey=[your account key];" Note that HTTPS is required.

containerName

String

The name of the container from which to read blobs.

pathPrefix

String

Optional. If specified, the datasource will include only blobs with names starting with this prefix. This is useful when blobs are organized into "virtual folders", for example.

deletionDetectionPolicy

DataDeletionDetectionPolicy

Optional. The data deletion detection policy for the datasource.

description

String

Optional. Description of the datasource.

Returns

DataSource

A new DataSource instance.