DataConnectors interface
Interface representing a DataConnectors.
Methods
| connect(string, string, string, Data |
Connects a data connector. |
| create |
Creates or updates the data connector. |
| delete(string, string, string, Data |
Delete the data connector. |
| disconnect(string, string, string, Data |
Disconnect a data connector. |
| get(string, string, string, Data |
Gets a data connector. |
| list(string, string, Data |
Gets all data connectors. |
Method Details
connect(string, string, string, DataConnectorConnectBody, DataConnectorsConnectOptionalParams)
Connects a data connector.
function connect(resourceGroupName: string, workspaceName: string, dataConnectorId: string, connectBody: DataConnectorConnectBody, options?: DataConnectorsConnectOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- dataConnectorId
-
string
Connector ID
- connectBody
- DataConnectorConnectBody
The data connector
The options parameters.
Returns
Promise<void>
createOrUpdate(string, string, string, DataConnectorUnion, DataConnectorsCreateOrUpdateOptionalParams)
Creates or updates the data connector.
function createOrUpdate(resourceGroupName: string, workspaceName: string, dataConnectorId: string, dataConnector: DataConnectorUnion, options?: DataConnectorsCreateOrUpdateOptionalParams): Promise<DataConnectorUnion>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- dataConnectorId
-
string
Connector ID
- dataConnector
- DataConnectorUnion
The data connector
The options parameters.
Returns
Promise<DataConnectorUnion>
delete(string, string, string, DataConnectorsDeleteOptionalParams)
Delete the data connector.
function delete(resourceGroupName: string, workspaceName: string, dataConnectorId: string, options?: DataConnectorsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- dataConnectorId
-
string
Connector ID
The options parameters.
Returns
Promise<void>
disconnect(string, string, string, DataConnectorsDisconnectOptionalParams)
Disconnect a data connector.
function disconnect(resourceGroupName: string, workspaceName: string, dataConnectorId: string, options?: DataConnectorsDisconnectOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- dataConnectorId
-
string
Connector ID
The options parameters.
Returns
Promise<void>
get(string, string, string, DataConnectorsGetOptionalParams)
Gets a data connector.
function get(resourceGroupName: string, workspaceName: string, dataConnectorId: string, options?: DataConnectorsGetOptionalParams): Promise<DataConnectorUnion>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- dataConnectorId
-
string
Connector ID
- options
- DataConnectorsGetOptionalParams
The options parameters.
Returns
Promise<DataConnectorUnion>
list(string, string, DataConnectorsListOptionalParams)
Gets all data connectors.
function list(resourceGroupName: string, workspaceName: string, options?: DataConnectorsListOptionalParams): PagedAsyncIterableIterator<DataConnectorUnion, DataConnectorUnion[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- options
- DataConnectorsListOptionalParams
The options parameters.
Returns
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for