tessl/pypi-azure-mgmt-synapse
Microsoft Azure Synapse Management Client Library for Python
—
Pending
Quality
Pending
Does it follow best practices?
Impact
Pending
No eval scenarios have been run
integration-runtime-management.mddocs/
Integration Runtime Management
Integration runtime provisioning, configuration, monitoring, and credential management for data integration scenarios. Integration runtimes provide the compute infrastructure for data movement, data flow execution, and SSIS package execution within Azure Synapse Analytics.
Capabilities
Integration Runtime Operations
Core integration runtime lifecycle management including creation, retrieval, updates, and deletion.
def get(resource_group_name: str, workspace_name: str, integration_runtime_name: str) -> IntegrationRuntimeResource:
"""
Get an integration runtime.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
Returns:
IntegrationRuntimeResource: The integration runtime object
"""
def create(resource_group_name: str, workspace_name: str, integration_runtime_name: str, integration_runtime: IntegrationRuntimeResource) -> LROPoller[IntegrationRuntimeResource]:
"""
Create an integration runtime.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
- integration_runtime (IntegrationRuntimeResource): Integration runtime properties
Returns:
LROPoller[IntegrationRuntimeResource]: Long-running operation poller
"""
def update(resource_group_name: str, workspace_name: str, integration_runtime_name: str, update_integration_runtime_request: UpdateIntegrationRuntimeRequest) -> IntegrationRuntimeResource:
"""
Update integration runtime properties.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
- update_integration_runtime_request (UpdateIntegrationRuntimeRequest): Update parameters
Returns:
IntegrationRuntimeResource: Updated integration runtime
"""
def delete(resource_group_name: str, workspace_name: str, integration_runtime_name: str) -> LROPoller[object]:
"""
Delete an integration runtime.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
Returns:
LROPoller[object]: Long-running operation poller
"""
def list_by_workspace(resource_group_name: str, workspace_name: str) -> ItemPaged[IntegrationRuntimeResource]:
"""
List integration runtimes in a workspace.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
Returns:
ItemPaged[IntegrationRuntimeResource]: Paged collection of integration runtimes
"""Integration Runtime State Management
Operations to control integration runtime state including start, stop, and upgrade operations.
def start(resource_group_name: str, workspace_name: str, integration_runtime_name: str) -> LROPoller[IntegrationRuntimeStatusResponse]:
"""
Start an integration runtime.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
Returns:
LROPoller[IntegrationRuntimeStatusResponse]: Long-running operation poller
"""
def stop(resource_group_name: str, workspace_name: str, integration_runtime_name: str) -> LROPoller[object]:
"""
Stop an integration runtime.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
Returns:
LROPoller[object]: Long-running operation poller
"""
def upgrade(resource_group_name: str, workspace_name: str, integration_runtime_name: str) -> None:
"""
Upgrade an integration runtime.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
"""Integration Runtime Status and Monitoring
Monitor integration runtime status, performance, and health.
def get_status(resource_group_name: str, workspace_name: str, integration_runtime_name: str) -> IntegrationRuntimeStatusResponse:
"""
Get integration runtime status.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
Returns:
IntegrationRuntimeStatusResponse: Integration runtime status
"""
def get_monitoring_data(resource_group_name: str, workspace_name: str, integration_runtime_name: str) -> IntegrationRuntimeMonitoringData:
"""
Get integration runtime monitoring data.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
Returns:
IntegrationRuntimeMonitoringData: Monitoring data
"""
def get_connection_info(resource_group_name: str, workspace_name: str, integration_runtime_name: str) -> IntegrationRuntimeConnectionInfo:
"""
Get integration runtime connection info.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
Returns:
IntegrationRuntimeConnectionInfo: Connection information
"""Integration Runtime Authentication
Manage authentication keys and credentials for integration runtime security.
def list_auth_keys(resource_group_name: str, workspace_name: str, integration_runtime_name: str) -> IntegrationRuntimeAuthKeys:
"""
List integration runtime authentication keys.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
Returns:
IntegrationRuntimeAuthKeys: Authentication keys
"""
def regenerate_auth_key(resource_group_name: str, workspace_name: str, integration_runtime_name: str, regenerate_key_parameters: IntegrationRuntimeRegenerateKeyParameters) -> IntegrationRuntimeAuthKeys:
"""
Regenerate integration runtime authentication key.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
- regenerate_key_parameters (IntegrationRuntimeRegenerateKeyParameters): Key regeneration parameters
Returns:
IntegrationRuntimeAuthKeys: New authentication keys
"""
def sync_credentials(resource_group_name: str, workspace_name: str, integration_runtime_name: str) -> None:
"""
Sync integration runtime credentials.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
"""Integration Runtime Node Management
Manage individual nodes within self-hosted integration runtimes.
def get_node(resource_group_name: str, workspace_name: str, integration_runtime_name: str, node_name: str) -> SelfHostedIntegrationRuntimeNode:
"""
Get integration runtime node.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
- node_name (str): Name of the node
Returns:
SelfHostedIntegrationRuntimeNode: Integration runtime node
"""
def update_node(resource_group_name: str, workspace_name: str, integration_runtime_name: str, node_name: str, update_integration_runtime_node_request: UpdateIntegrationRuntimeNodeRequest) -> SelfHostedIntegrationRuntimeNode:
"""
Update integration runtime node.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
- node_name (str): Name of the node
- update_integration_runtime_node_request (UpdateIntegrationRuntimeNodeRequest): Update parameters
Returns:
SelfHostedIntegrationRuntimeNode: Updated integration runtime node
"""
def delete_node(resource_group_name: str, workspace_name: str, integration_runtime_name: str, node_name: str) -> None:
"""
Delete integration runtime node.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
- node_name (str): Name of the node
"""
def get_node_ip_address(resource_group_name: str, workspace_name: str, integration_runtime_name: str, node_name: str) -> IntegrationRuntimeNodeIpAddress:
"""
Get integration runtime node IP address.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
- node_name (str): Name of the node
Returns:
IntegrationRuntimeNodeIpAddress: Node IP address
"""SSIS Object Metadata Management
Manage SSIS packages, projects, and environments for SQL Server Integration Services workloads.
def get_ssis_object_metadata(resource_group_name: str, workspace_name: str, integration_runtime_name: str, get_ssis_object_metadata_request: GetSsisObjectMetadataRequest) -> SsisObjectMetadataListResponse:
"""
Get SSIS object metadata.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
- get_ssis_object_metadata_request (GetSsisObjectMetadataRequest): Metadata request parameters
Returns:
SsisObjectMetadataListResponse: SSIS object metadata
"""
def refresh_ssis_object_metadata(resource_group_name: str, workspace_name: str, integration_runtime_name: str) -> LROPoller[SsisObjectMetadataStatusResponse]:
"""
Refresh SSIS object metadata.
Parameters:
- resource_group_name (str): Name of the resource group
- workspace_name (str): Name of the workspace
- integration_runtime_name (str): Name of the integration runtime
Returns:
LROPoller[SsisObjectMetadataStatusResponse]: Long-running operation poller
"""Types
IntegrationRuntimeResource
class IntegrationRuntimeResource:
"""
Integration runtime resource.
Attributes:
- id (str): Resource ID
- name (str): Resource name
- type (str): Resource type
- etag (str): Entity tag
- properties (IntegrationRuntime): Integration runtime properties
"""IntegrationRuntime
class IntegrationRuntime:
"""
Base class for integration runtime.
Attributes:
- type (str): Integration runtime type
- description (str): Integration runtime description
"""ManagedIntegrationRuntime
class ManagedIntegrationRuntime:
"""
Managed integration runtime.
Attributes:
- type (str): Integration runtime type
- description (str): Integration runtime description
- state (str): Integration runtime state
- compute_properties (IntegrationRuntimeComputeProperties): Compute properties
- ssis_properties (IntegrationRuntimeSsisProperties): SSIS properties
"""SelfHostedIntegrationRuntime
class SelfHostedIntegrationRuntime:
"""
Self-hosted integration runtime.
Attributes:
- type (str): Integration runtime type
- description (str): Integration runtime description
- linked_info (LinkedIntegrationRuntimeType): Linked integration runtime info
"""IntegrationRuntimeComputeProperties
class IntegrationRuntimeComputeProperties:
"""
Integration runtime compute properties.
Attributes:
- location (str): Compute location
- node_size (str): Node size
- number_of_nodes (int): Number of nodes
- max_parallel_executions_per_node (int): Max parallel executions per node
- data_flow_properties (IntegrationRuntimeDataFlowProperties): Data flow properties
- v_net_properties (IntegrationRuntimeVNetProperties): VNet properties
"""IntegrationRuntimeSsisProperties
class IntegrationRuntimeSsisProperties:
"""
Integration runtime SSIS properties.
Attributes:
- catalog_info (IntegrationRuntimeSsisCatalogInfo): SSIS catalog info
- license_type (str): License type
- custom_setup_script_properties (IntegrationRuntimeCustomSetupScriptProperties): Custom setup script properties
- data_proxy_properties (IntegrationRuntimeDataProxyProperties): Data proxy properties
- edition (str): SSIS edition
- express_custom_setup_properties (list): Express custom setup properties
"""IntegrationRuntimeStatusResponse
class IntegrationRuntimeStatusResponse:
"""
Integration runtime status response.
Attributes:
- name (str): Integration runtime name
- properties (IntegrationRuntimeStatus): Status properties
"""IntegrationRuntimeAuthKeys
class IntegrationRuntimeAuthKeys:
"""
Integration runtime authentication keys.
Attributes:
- auth_key1 (str): Authentication key 1
- auth_key2 (str): Authentication key 2
"""IntegrationRuntimeMonitoringData
class IntegrationRuntimeMonitoringData:
"""
Integration runtime monitoring data.
Attributes:
- name (str): Integration runtime name
- nodes (list): Node monitoring data
"""Usage Examples
Create Managed Integration Runtime
from azure.mgmt.synapse.models import (
IntegrationRuntimeResource, ManagedIntegrationRuntime,
IntegrationRuntimeComputeProperties, IntegrationRuntimeDataFlowProperties
)
# Configure compute properties
data_flow_properties = IntegrationRuntimeDataFlowProperties(
compute_type="General",
core_count=8,
time_to_live=10
)
compute_properties = IntegrationRuntimeComputeProperties(
location="East US",
node_size="Standard_D4_v2",
number_of_nodes=2,
max_parallel_executions_per_node=2,
data_flow_properties=data_flow_properties
)
# Create managed integration runtime
managed_ir = ManagedIntegrationRuntime(
type="Managed",
description="Managed IR for data flows",
compute_properties=compute_properties
)
ir_resource = IntegrationRuntimeResource(
properties=managed_ir
)
operation = client.integration_runtimes.create(
resource_group_name="my-resource-group",
workspace_name="my-synapse-workspace",
integration_runtime_name="my-managed-ir",
integration_runtime=ir_resource
)
integration_runtime = operation.result()
print(f"Created integration runtime: {integration_runtime.name}")Create Self-Hosted Integration Runtime
from azure.mgmt.synapse.models import (
IntegrationRuntimeResource, SelfHostedIntegrationRuntime
)
# Create self-hosted integration runtime
self_hosted_ir = SelfHostedIntegrationRuntime(
type="SelfHosted",
description="Self-hosted IR for on-premises data"
)
ir_resource = IntegrationRuntimeResource(
properties=self_hosted_ir
)
operation = client.integration_runtimes.create(
resource_group_name="my-resource-group",
workspace_name="my-synapse-workspace",
integration_runtime_name="my-self-hosted-ir",
integration_runtime=ir_resource
)
integration_runtime = operation.result()
# Get authentication keys for installation
auth_keys = client.integration_runtime_auth_keys.list_auth_keys(
resource_group_name="my-resource-group",
workspace_name="my-synapse-workspace",
integration_runtime_name="my-self-hosted-ir"
)
print(f"Authentication Key 1: {auth_keys.auth_key1}")
print(f"Authentication Key 2: {auth_keys.auth_key2}")Monitor Integration Runtime
# Get integration runtime status
status = client.integration_runtime_status.get_status(
resource_group_name="my-resource-group",
workspace_name="my-synapse-workspace",
integration_runtime_name="my-managed-ir"
)
print(f"IR Status: {status.properties.state}")
# Get monitoring data
monitoring_data = client.integration_runtime_monitoring_data.get_monitoring_data(
resource_group_name="my-resource-group",
workspace_name="my-synapse-workspace",
integration_runtime_name="my-managed-ir"
)
print(f"Node count: {len(monitoring_data.nodes)}")
for node in monitoring_data.nodes:
print(f"Node: {node.node_name}, Status: {node.status}")Install with Tessl CLI
npx tessl i tessl/pypi-azure-mgmt-synapse