IntegrationRuntimes | @azure/arm-synapse

Interface representing a IntegrationRuntimes.

Hierarchy

IntegrationRuntimes

Implemented by

IntegrationRuntimesImpl

Index

Methods

beginCreate

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

- Defined in operationsInterfaces/integrationRuntimes.ts:82
Create an integration runtime

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.
- Optional options: IntegrationRuntimesCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<IntegrationRuntimesCreateResponse>, IntegrationRuntimesCreateResponse>>

beginCreateAndWait

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

- Defined in operationsInterfaces/integrationRuntimes.ts:102
Create an integration runtime

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.
- Optional options: IntegrationRuntimesCreateOptionalParams
  
  The options parameters.
Returns Promise<IntegrationRuntimesCreateResponse>

beginDelete

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

- Defined in operationsInterfaces/integrationRuntimes.ts:116
Delete an integration runtime

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
- Optional options: IntegrationRuntimesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/integrationRuntimes.ts:129
Delete an integration runtime

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
- Optional options: IntegrationRuntimesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDisableInteractiveQuery

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

- Defined in operationsInterfaces/integrationRuntimes.ts:253
Disable interactive query in integration runtime

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
- Optional options: IntegrationRuntimesDisableInteractiveQueryOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDisableInteractiveQueryAndWait

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

- Defined in operationsInterfaces/integrationRuntimes.ts:266
Disable interactive query in integration runtime

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
- Optional options: IntegrationRuntimesDisableInteractiveQueryOptionalParams
  
  The options parameters.
Returns Promise<void>

beginEnableInteractiveQuery

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

- Defined in operationsInterfaces/integrationRuntimes.ts:227
Enable interactive query in integration runtime

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
- Optional options: IntegrationRuntimesEnableInteractiveQueryOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginEnableInteractiveQueryAndWait

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

- Defined in operationsInterfaces/integrationRuntimes.ts:240
Enable interactive query in integration runtime

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
- Optional options: IntegrationRuntimesEnableInteractiveQueryOptionalParams
  
  The options parameters.
Returns Promise<void>

beginStart

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

- Defined in operationsInterfaces/integrationRuntimes.ts:155
Start an integration runtime

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
- Optional options: IntegrationRuntimesStartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<IntegrationRuntimesStartResponse>, IntegrationRuntimesStartResponse>>

beginStartAndWait

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

- Defined in operationsInterfaces/integrationRuntimes.ts:173
Start an integration runtime

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
- Optional options: IntegrationRuntimesStartOptionalParams
  
  The options parameters.
Returns Promise<IntegrationRuntimesStartResponse>

beginStop

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

- Defined in operationsInterfaces/integrationRuntimes.ts:186
Stop an integration runtime

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
- Optional options: IntegrationRuntimesStopOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStopAndWait

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

- Defined in operationsInterfaces/integrationRuntimes.ts:199
Stop an integration runtime

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
- Optional options: IntegrationRuntimesStopOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/integrationRuntimes.ts:68
Get an integration runtime

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
- Optional options: IntegrationRuntimesGetOptionalParams
  
  The options parameters.
Returns Promise<IntegrationRuntimesGetResponse>

listByWorkspace

listByWorkspace(resourceGroupName: string, workspaceName: string, options?: IntegrationRuntimesListByWorkspaceOptionalParams): PagedAsyncIterableIterator<IntegrationRuntimeResource>

- Defined in operationsInterfaces/integrationRuntimes.ts:41
List all integration runtimes

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- Optional options: IntegrationRuntimesListByWorkspaceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<IntegrationRuntimeResource>

listOutboundNetworkDependenciesEndpoints

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

- Defined in operationsInterfaces/integrationRuntimes.ts:212
Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.

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
- Optional options: IntegrationRuntimesListOutboundNetworkDependenciesEndpointsOptionalParams
  
  The options parameters.
Returns Promise<IntegrationRuntimesListOutboundNetworkDependenciesEndpointsResponse>

update

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

- Defined in operationsInterfaces/integrationRuntimes.ts:54
Update an integration runtime

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.
- Optional options: IntegrationRuntimesUpdateOptionalParams
  
  The options parameters.
Returns Promise<IntegrationRuntimesUpdateResponse>

upgrade

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

- Defined in operationsInterfaces/integrationRuntimes.ts:142
Upgrade an integration runtime

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
- Optional options: IntegrationRuntimesUpgradeOptionalParams
  
  The options parameters.
Returns Promise<void>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreate

Parameters

resourceGroupName: string

workspaceName: string

integrationRuntimeName: string

integrationRuntime: IntegrationRuntimeResource

Optional options: IntegrationRuntimesCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<IntegrationRuntimesCreateResponse>, IntegrationRuntimesCreateResponse>>

beginCreateAndWait

Parameters

resourceGroupName: string

workspaceName: string

integrationRuntimeName: string

integrationRuntime: IntegrationRuntimeResource

Optional options: IntegrationRuntimesCreateOptionalParams

Returns Promise<IntegrationRuntimesCreateResponse>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

integrationRuntimeName: string

Optional options: IntegrationRuntimesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

integrationRuntimeName: string

Optional options: IntegrationRuntimesDeleteOptionalParams

Returns Promise<void>

beginDisableInteractiveQuery

Parameters

resourceGroupName: string

workspaceName: string

integrationRuntimeName: string

Optional options: IntegrationRuntimesDisableInteractiveQueryOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDisableInteractiveQueryAndWait

Parameters

resourceGroupName: string

workspaceName: string

integrationRuntimeName: string

Optional options: IntegrationRuntimesDisableInteractiveQueryOptionalParams

Returns Promise<void>

beginEnableInteractiveQuery

Parameters

resourceGroupName: string

workspaceName: string

integrationRuntimeName: string

Optional options: IntegrationRuntimesEnableInteractiveQueryOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginEnableInteractiveQueryAndWait

Parameters

resourceGroupName: string

workspaceName: string

integrationRuntimeName: string

Optional options: IntegrationRuntimesEnableInteractiveQueryOptionalParams

Returns Promise<void>

beginStart

Parameters

resourceGroupName: string

workspaceName: string

integrationRuntimeName: string

Optional options: IntegrationRuntimesStartOptionalParams

Returns Promise<PollerLike<PollOperationState<IntegrationRuntimesStartResponse>, IntegrationRuntimesStartResponse>>

beginStartAndWait

Parameters

resourceGroupName: string

workspaceName: string

integrationRuntimeName: string

Optional options: IntegrationRuntimesStartOptionalParams

Returns Promise<IntegrationRuntimesStartResponse>

beginStop

Parameters

resourceGroupName: string