IotConnectors interface
Interface representing a IotConnectors.
Methods
Method Details
beginCreateOrUpdate(string, string, string, IotConnector, IotConnectorsCreateOrUpdateOptionalParams)
Creates or updates an IoT Connector resource with the specified parameters.
function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, iotConnectorName: string, iotConnector: IotConnector, options?: IotConnectorsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotConnector>, IotConnector>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- workspaceName
-
string
The name of workspace resource.
- iotConnectorName
-
string
The name of IoT Connector resource.
- iotConnector
- IotConnector
The parameters for creating or updating an IoT Connectors resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotConnector>, IotConnector>>
beginCreateOrUpdateAndWait(string, string, string, IotConnector, IotConnectorsCreateOrUpdateOptionalParams)
Creates or updates an IoT Connector resource with the specified parameters.
function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, iotConnectorName: string, iotConnector: IotConnector, options?: IotConnectorsCreateOrUpdateOptionalParams): Promise<IotConnector>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- workspaceName
-
string
The name of workspace resource.
- iotConnectorName
-
string
The name of IoT Connector resource.
- iotConnector
- IotConnector
The parameters for creating or updating an IoT Connectors resource.
The options parameters.
Returns
Promise<IotConnector>
beginDelete(string, string, string, IotConnectorsDeleteOptionalParams)
Deletes an IoT Connector.
function beginDelete(resourceGroupName: string, iotConnectorName: string, workspaceName: string, options?: IotConnectorsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- iotConnectorName
-
string
The name of IoT Connector resource.
- workspaceName
-
string
The name of workspace resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, IotConnectorsDeleteOptionalParams)
Deletes an IoT Connector.
function beginDeleteAndWait(resourceGroupName: string, iotConnectorName: string, workspaceName: string, options?: IotConnectorsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- iotConnectorName
-
string
The name of IoT Connector resource.
- workspaceName
-
string
The name of workspace resource.
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, IotConnectorPatchResource, IotConnectorsUpdateOptionalParams)
Patch an IoT Connector.
function beginUpdate(resourceGroupName: string, iotConnectorName: string, workspaceName: string, iotConnectorPatchResource: IotConnectorPatchResource, options?: IotConnectorsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotConnector>, IotConnector>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- iotConnectorName
-
string
The name of IoT Connector resource.
- workspaceName
-
string
The name of workspace resource.
- iotConnectorPatchResource
- IotConnectorPatchResource
The parameters for updating an IoT Connector.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotConnector>, IotConnector>>
beginUpdateAndWait(string, string, string, IotConnectorPatchResource, IotConnectorsUpdateOptionalParams)
Patch an IoT Connector.
function beginUpdateAndWait(resourceGroupName: string, iotConnectorName: string, workspaceName: string, iotConnectorPatchResource: IotConnectorPatchResource, options?: IotConnectorsUpdateOptionalParams): Promise<IotConnector>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- iotConnectorName
-
string
The name of IoT Connector resource.
- workspaceName
-
string
The name of workspace resource.
- iotConnectorPatchResource
- IotConnectorPatchResource
The parameters for updating an IoT Connector.
The options parameters.
Returns
Promise<IotConnector>
get(string, string, string, IotConnectorsGetOptionalParams)
Gets the properties of the specified IoT Connector.
function get(resourceGroupName: string, workspaceName: string, iotConnectorName: string, options?: IotConnectorsGetOptionalParams): Promise<IotConnector>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- workspaceName
-
string
The name of workspace resource.
- iotConnectorName
-
string
The name of IoT Connector resource.
- options
- IotConnectorsGetOptionalParams
The options parameters.
Returns
Promise<IotConnector>
listByWorkspace(string, string, IotConnectorsListByWorkspaceOptionalParams)
Lists all IoT Connectors for the given workspace
function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: IotConnectorsListByWorkspaceOptionalParams): PagedAsyncIterableIterator<IotConnector, IotConnector[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- workspaceName
-
string
The name of workspace resource.
The options parameters.