IntegrationRuntimes interface

Package:

@azure/arm-synapse

Interface representing a IntegrationRuntimes.

Methods

beginCreate(string, string, string, IntegrationRuntimeResource, IntegrationRuntimesCreateOptionalParams)	Create an integration runtime
beginCreateAndWait(string, string, string, IntegrationRuntimeResource, IntegrationRuntimesCreateOptionalParams)	Create an integration runtime
beginDelete(string, string, string, IntegrationRuntimesDeleteOptionalParams)	Delete an integration runtime
beginDeleteAndWait(string, string, string, IntegrationRuntimesDeleteOptionalParams)	Delete an integration runtime
beginDisableInteractiveQuery(string, string, string, IntegrationRuntimesDisableInteractiveQueryOptionalParams)	Disable interactive query in integration runtime
beginDisableInteractiveQueryAndWait(string, string, string, IntegrationRuntimesDisableInteractiveQueryOptionalParams)	Disable interactive query in integration runtime
beginEnableInteractiveQuery(string, string, string, IntegrationRuntimesEnableInteractiveQueryOptionalParams)	Enable interactive query in integration runtime
beginEnableInteractiveQueryAndWait(string, string, string, IntegrationRuntimesEnableInteractiveQueryOptionalParams)	Enable interactive query in integration runtime
beginStart(string, string, string, IntegrationRuntimesStartOptionalParams)	Start an integration runtime
beginStartAndWait(string, string, string, IntegrationRuntimesStartOptionalParams)	Start an integration runtime
beginStop(string, string, string, IntegrationRuntimesStopOptionalParams)	Stop an integration runtime
beginStopAndWait(string, string, string, IntegrationRuntimesStopOptionalParams)	Stop an integration runtime
get(string, string, string, IntegrationRuntimesGetOptionalParams)	Get an integration runtime
listByWorkspace(string, string, IntegrationRuntimesListByWorkspaceOptionalParams)	List all integration runtimes
listOutboundNetworkDependenciesEndpoints(string, string, string, IntegrationRuntimesListOutboundNetworkDependenciesEndpointsOptionalParams)	Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
update(string, string, string, UpdateIntegrationRuntimeRequest, IntegrationRuntimesUpdateOptionalParams)	Update an integration runtime
upgrade(string, string, string, IntegrationRuntimesUpgradeOptionalParams)	Upgrade an integration runtime

Method Details

beginCreate(string, string, string, IntegrationRuntimeResource, IntegrationRuntimesCreateOptionalParams)

Create an integration runtime

function beginCreate(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, integrationRuntime: IntegrationRuntimeResource, options?: IntegrationRuntimesCreateOptionalParams): Promise<PollerLike<PollOperationState<IntegrationRuntimeResource>, IntegrationRuntimeResource>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

integrationRuntime

IntegrationRuntimeResource

Integration runtime resource definition.

options

IntegrationRuntimesCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<IntegrationRuntimeResource>, IntegrationRuntimeResource>>

beginCreateAndWait(string, string, string, IntegrationRuntimeResource, IntegrationRuntimesCreateOptionalParams)

Create an integration runtime

function beginCreateAndWait(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, integrationRuntime: IntegrationRuntimeResource, options?: IntegrationRuntimesCreateOptionalParams): Promise<IntegrationRuntimeResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

integrationRuntime

IntegrationRuntimeResource

Integration runtime resource definition.

options

IntegrationRuntimesCreateOptionalParams

The options parameters.

Returns

Promise<IntegrationRuntimeResource>

beginDelete(string, string, string, IntegrationRuntimesDeleteOptionalParams)

Delete an integration runtime

function beginDelete(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, options?: IntegrationRuntimesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

options

IntegrationRuntimesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, IntegrationRuntimesDeleteOptionalParams)

Delete an integration runtime

function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, options?: IntegrationRuntimesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

options

IntegrationRuntimesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDisableInteractiveQuery(string, string, string, IntegrationRuntimesDisableInteractiveQueryOptionalParams)

Disable interactive query in integration runtime

function beginDisableInteractiveQuery(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, options?: IntegrationRuntimesDisableInteractiveQueryOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

options

IntegrationRuntimesDisableInteractiveQueryOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDisableInteractiveQueryAndWait(string, string, string, IntegrationRuntimesDisableInteractiveQueryOptionalParams)

Disable interactive query in integration runtime

function beginDisableInteractiveQueryAndWait(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, options?: IntegrationRuntimesDisableInteractiveQueryOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

options

IntegrationRuntimesDisableInteractiveQueryOptionalParams

The options parameters.

Returns

Promise<void>

beginEnableInteractiveQuery(string, string, string, IntegrationRuntimesEnableInteractiveQueryOptionalParams)

Enable interactive query in integration runtime

function beginEnableInteractiveQuery(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, options?: IntegrationRuntimesEnableInteractiveQueryOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

options

IntegrationRuntimesEnableInteractiveQueryOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginEnableInteractiveQueryAndWait(string, string, string, IntegrationRuntimesEnableInteractiveQueryOptionalParams)

Enable interactive query in integration runtime

function beginEnableInteractiveQueryAndWait(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, options?: IntegrationRuntimesEnableInteractiveQueryOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

options

IntegrationRuntimesEnableInteractiveQueryOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, string, IntegrationRuntimesStartOptionalParams)

Start an integration runtime

function beginStart(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStartOptionalParams): Promise<PollerLike<PollOperationState<IntegrationRuntimeStatusResponse>, IntegrationRuntimeStatusResponse>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

options

IntegrationRuntimesStartOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<IntegrationRuntimeStatusResponse>, IntegrationRuntimeStatusResponse>>

beginStartAndWait(string, string, string, IntegrationRuntimesStartOptionalParams)

Start an integration runtime

function beginStartAndWait(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStartOptionalParams): Promise<IntegrationRuntimeStatusResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

options

IntegrationRuntimesStartOptionalParams

The options parameters.

Returns

Promise<IntegrationRuntimeStatusResponse>

beginStop(string, string, string, IntegrationRuntimesStopOptionalParams)

Stop an integration runtime

function beginStop(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

options

IntegrationRuntimesStopOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginStopAndWait(string, string, string, IntegrationRuntimesStopOptionalParams)

Stop an integration runtime

function beginStopAndWait(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, options?: IntegrationRuntimesStopOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

options

IntegrationRuntimesStopOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, IntegrationRuntimesGetOptionalParams)

Get an integration runtime

function get(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, options?: IntegrationRuntimesGetOptionalParams): Promise<IntegrationRuntimeResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

options

IntegrationRuntimesGetOptionalParams

The options parameters.

Returns

Promise<IntegrationRuntimeResource>

listByWorkspace(string, string, IntegrationRuntimesListByWorkspaceOptionalParams)

List all integration runtimes

function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: IntegrationRuntimesListByWorkspaceOptionalParams): PagedAsyncIterableIterator<IntegrationRuntimeResource, IntegrationRuntimeResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

options

IntegrationRuntimesListByWorkspaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<IntegrationRuntimeResource, IntegrationRuntimeResource[], PageSettings>

listOutboundNetworkDependenciesEndpoints(string, string, string, IntegrationRuntimesListOutboundNetworkDependenciesEndpointsOptionalParams)

Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.

function listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, options?: IntegrationRuntimesListOutboundNetworkDependenciesEndpointsOptionalParams): Promise<IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

options

IntegrationRuntimesListOutboundNetworkDependenciesEndpointsOptionalParams

The options parameters.

Returns

Promise<IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse>

update(string, string, string, UpdateIntegrationRuntimeRequest, IntegrationRuntimesUpdateOptionalParams)

Update an integration runtime

function update(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, updateIntegrationRuntimeRequest: UpdateIntegrationRuntimeRequest, options?: IntegrationRuntimesUpdateOptionalParams): Promise<IntegrationRuntimeResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

updateIntegrationRuntimeRequest

UpdateIntegrationRuntimeRequest

The parameters for updating an integration runtime.

options

IntegrationRuntimesUpdateOptionalParams

The options parameters.

Returns

Promise<IntegrationRuntimeResource>

upgrade(string, string, string, IntegrationRuntimesUpgradeOptionalParams)

Upgrade an integration runtime

function upgrade(resourceGroupName: string, workspaceName: string, integrationRuntimeName: string, options?: IntegrationRuntimesUpgradeOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

integrationRuntimeName

string

Integration runtime name

options

IntegrationRuntimesUpgradeOptionalParams

The options parameters.

Returns

Promise<void>