DataSources | @azure/search-documents

Class representing a DataSources.

Hierarchy

DataSources

Index

Constructors

constructor

Methods

Constructors

constructor

new DataSources(client: SearchServiceClientContext): DataSources

- Defined in generated/service/operations/dataSources.ts:19
Create a DataSources.

Parameters
- client: SearchServiceClientContext
  
  Reference to the service client.
Returns DataSources

Methods

create

create(dataSource: SearchIndexerDataSource, options?: coreHttp.RequestOptionsBase): Promise<Models.DataSourcesCreateResponse>
create(dataSource: SearchIndexerDataSource, callback: coreHttp.ServiceCallback<SearchIndexerDataSource>): void
create(dataSource: SearchIndexerDataSource, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<SearchIndexerDataSource>): void

- Defined in generated/service/operations/dataSources.ts:147
Creates a new datasource.

Parameters
- dataSource: SearchIndexerDataSource
  
  The definition of the datasource to create.
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<Models.DataSourcesCreateResponse>

Promise<Models.DataSourcesCreateResponse>
- Defined in generated/service/operations/dataSources.ts:152
Parameters
- dataSource: SearchIndexerDataSource
  
  The definition of the datasource to create.
- callback: coreHttp.ServiceCallback<SearchIndexerDataSource>
  
  The callback
Returns void
- Defined in generated/service/operations/dataSources.ts:158
Parameters
- dataSource: SearchIndexerDataSource
  
  The definition of the datasource to create.
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<SearchIndexerDataSource>
  
  The callback
Returns void

createOrUpdate

createOrUpdate(dataSourceName: string, dataSource: SearchIndexerDataSource, options?: Models.DataSourcesCreateOrUpdateOptionalParams): Promise<Models.DataSourcesCreateOrUpdateResponse>
createOrUpdate(dataSourceName: string, dataSource: SearchIndexerDataSource, callback: coreHttp.ServiceCallback<SearchIndexerDataSource>): void
createOrUpdate(dataSourceName: string, dataSource: SearchIndexerDataSource, options: DataSourcesCreateOrUpdateOptionalParams, callback: coreHttp.ServiceCallback<SearchIndexerDataSource>): void

- Defined in generated/service/operations/dataSources.ts:36
Creates a new datasource or updates a datasource if it already exists.

Parameters
- dataSourceName: string
  
  The name of the datasource to create or update.
- dataSource: SearchIndexerDataSource
  
  The definition of the datasource to create or update.
- Optional options: Models.DataSourcesCreateOrUpdateOptionalParams
Returns Promise<Models.DataSourcesCreateOrUpdateResponse>

Promise<Models.DataSourcesCreateOrUpdateResponse>
- Defined in generated/service/operations/dataSources.ts:42
Parameters
- dataSourceName: string
  
  The name of the datasource to create or update.
- dataSource: SearchIndexerDataSource
  
  The definition of the datasource to create or update.
- callback: coreHttp.ServiceCallback<SearchIndexerDataSource>
  
  The callback
Returns void
- Defined in generated/service/operations/dataSources.ts:49
Parameters
- dataSourceName: string
  
  The name of the datasource to create or update.
- dataSource: SearchIndexerDataSource
  
  The definition of the datasource to create or update.
- options: DataSourcesCreateOrUpdateOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<SearchIndexerDataSource>
  
  The callback
Returns void

deleteMethod

deleteMethod(dataSourceName: string, options?: Models.DataSourcesDeleteMethodOptionalParams): Promise<coreHttp.RestResponse>
deleteMethod(dataSourceName: string, callback: coreHttp.ServiceCallback<void>): void
deleteMethod(dataSourceName: string, options: DataSourcesDeleteMethodOptionalParams, callback: coreHttp.ServiceCallback<void>): void

- Defined in generated/service/operations/dataSources.ts:67
Deletes a datasource.

Parameters
- dataSourceName: string
  
  The name of the datasource to delete.
- Optional options: Models.DataSourcesDeleteMethodOptionalParams
Returns Promise<coreHttp.RestResponse>

Promise<coreHttp.RestResponse>
- Defined in generated/service/operations/dataSources.ts:72
Parameters
- dataSourceName: string
  
  The name of the datasource to delete.
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in generated/service/operations/dataSources.ts:78
Parameters
- dataSourceName: string
  
  The name of the datasource to delete.
- options: DataSourcesDeleteMethodOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

get

get(dataSourceName: string, options?: coreHttp.RequestOptionsBase): Promise<Models.DataSourcesGetResponse>
get(dataSourceName: string, callback: coreHttp.ServiceCallback<SearchIndexerDataSource>): void
get(dataSourceName: string, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<SearchIndexerDataSource>): void

- Defined in generated/service/operations/dataSources.ts:95
Retrieves a datasource definition.

Parameters
- dataSourceName: string
  
  The name of the datasource to retrieve.
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<Models.DataSourcesGetResponse>

Promise<Models.DataSourcesGetResponse>
- Defined in generated/service/operations/dataSources.ts:100
Parameters
- dataSourceName: string
  
  The name of the datasource to retrieve.
- callback: coreHttp.ServiceCallback<SearchIndexerDataSource>
  
  The callback
Returns void
- Defined in generated/service/operations/dataSources.ts:106
Parameters
- dataSourceName: string
  
  The name of the datasource to retrieve.
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<SearchIndexerDataSource>
  
  The callback
Returns void

list

list(options?: Models.DataSourcesListOptionalParams): Promise<Models.DataSourcesListResponse>
list(callback: coreHttp.ServiceCallback<ListDataSourcesResult>): void
list(options: DataSourcesListOptionalParams, callback: coreHttp.ServiceCallback<ListDataSourcesResult>): void

- Defined in generated/service/operations/dataSources.ts:122
Lists all datasources available for a search service.

Parameters
- Optional options: Models.DataSourcesListOptionalParams
Returns Promise<Models.DataSourcesListResponse>

Promise<Models.DataSourcesListResponse>
- Defined in generated/service/operations/dataSources.ts:126
Parameters
- callback: coreHttp.ServiceCallback<ListDataSourcesResult>
  
  The callback
Returns void
- Defined in generated/service/operations/dataSources.ts:131
Parameters
- options: DataSourcesListOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<ListDataSourcesResult>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: SearchServiceClientContext

Returns DataSources

Methods

create

Parameters

dataSource: SearchIndexerDataSource

Optional options: coreHttp.RequestOptionsBase

Returns Promise<Models.DataSourcesCreateResponse>

Parameters

dataSource: SearchIndexerDataSource

callback: coreHttp.ServiceCallback<SearchIndexerDataSource>

Returns void

Parameters

dataSource: SearchIndexerDataSource

options: coreHttp.RequestOptionsBase

callback: coreHttp.ServiceCallback<SearchIndexerDataSource>

Returns void

createOrUpdate

Parameters

dataSourceName: string

dataSource: SearchIndexerDataSource

Optional options: Models.DataSourcesCreateOrUpdateOptionalParams

Returns Promise<Models.DataSourcesCreateOrUpdateResponse>

Parameters

dataSourceName: string

dataSource: SearchIndexerDataSource

callback: coreHttp.ServiceCallback<SearchIndexerDataSource>

Returns void

Parameters

dataSourceName: string

dataSource: SearchIndexerDataSource

options: DataSourcesCreateOrUpdateOptionalParams

callback: coreHttp.ServiceCallback<SearchIndexerDataSource>

Returns void

deleteMethod

Parameters

dataSourceName: string

Optional options: Models.DataSourcesDeleteMethodOptionalParams

Returns Promise<coreHttp.RestResponse>

Parameters

dataSourceName: string

callback: coreHttp.ServiceCallback<void>

Returns void

Parameters

dataSourceName: string

options: DataSourcesDeleteMethodOptionalParams

callback: coreHttp.ServiceCallback<void>

Returns void

get

Parameters

dataSourceName: string

Optional options: coreHttp.RequestOptionsBase

Returns Promise<Models.DataSourcesGetResponse>

Parameters

dataSourceName: string

callback: coreHttp.ServiceCallback<SearchIndexerDataSource>

Returns void

Parameters

dataSourceName: string

options: coreHttp.RequestOptionsBase

callback: coreHttp.ServiceCallback<SearchIndexerDataSource>

Returns void

list

Parameters

Optional options: Models.DataSourcesListOptionalParams

Returns Promise<Models.DataSourcesListResponse>

Parameters

callback: coreHttp.ServiceCallback<ListDataSourcesResult>

Returns void

Parameters

options: DataSourcesListOptionalParams

callback: coreHttp.ServiceCallback<ListDataSourcesResult>

Returns void