espaces de travail/intégrationruntimes Microsoft.Synapse

Définition de ressource Bicep

Le type de ressource workspaces/integrationRuntimes peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Synapse/workspaces/integrationRuntimes, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    type: 'string'
    // For remaining properties, see IntegrationRuntime objects
  }
}

Objets SecretBase

Définissez le type propriété pour spécifier le type d’objet.

Pour SecureString, utilisez :

{
  type: 'SecureString'
  value: 'string'
}

Objets LinkedIntegrationRuntimeType

Définissez la propriété authorizationType pour spécifier le type d’objet.

Pour Key, utilisez :

{
  authorizationType: 'Key'
  key: {
    type: 'string'
    value: 'string'
  }
}

Pour le RBAC, utilisez :

{
  authorizationType: 'RBAC'
  resourceId: 'string'
}

Objets IntegrationRuntime

Définissez le type propriété pour spécifier le type d’objet.

Pour Managed, utilisez :

{
  managedVirtualNetwork: {
    id: 'string'
    referenceName: 'string'
    type: 'string'
  }
  type: 'Managed'
  typeProperties: {
    computeProperties: {
      dataFlowProperties: {
        computeType: 'string'
        coreCount: int
        timeToLive: int
      }
      location: 'string'
      maxParallelExecutionsPerNode: int
      nodeSize: 'string'
      numberOfNodes: int
      vNetProperties: {
        publicIPs: [
          'string'
        ]
        subnet: 'string'
        subnetId: 'string'
        vNetId: 'string'
      }
    }
    customerVirtualNetwork: {
      subnetId: 'string'
    }
    ssisProperties: {
      catalogInfo: {
        catalogAdminPassword: {
          type: 'string'
          value: 'string'
        }
        catalogAdminUserName: 'string'
        catalogPricingTier: 'string'
        catalogServerEndpoint: 'string'
      }
      customSetupScriptProperties: {
        blobContainerUri: 'string'
        sasToken: {
          type: 'string'
          value: 'string'
        }
      }
      dataProxyProperties: {
        connectVia: {
          referenceName: 'string'
          type: 'string'
        }
        path: 'string'
        stagingLinkedService: {
          referenceName: 'string'
          type: 'string'
        }
      }
      edition: 'string'
      expressCustomSetupProperties: [
        {
          type: 'string'
          // For remaining properties, see CustomSetupBase objects
        }
      ]
      licenseType: 'string'
    }
  }
}

Pour SelfHosted, utilisez :

{
  type: 'SelfHosted'
  typeProperties: {
    linkedInfo: {
      authorizationType: 'string'
      // For remaining properties, see LinkedIntegrationRuntimeType objects
    }
  }
}

Objets CustomSetupBase

Définissez le type propriété pour spécifier le type d’objet.

Pour CmdkeySetup, utilisez :

{
  type: 'CmdkeySetup'
  typeProperties: {
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    targetName: any(...)
    userName: any(...)
  }
}

Pour ComponentSetup, utilisez :

{
  type: 'ComponentSetup'
  typeProperties: {
    componentName: 'string'
    licenseKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
  }
}

Pour EnvironmentVariableSetup, utilisez :

{
  type: 'EnvironmentVariableSetup'
  typeProperties: {
    variableName: 'string'
    variableValue: 'string'
  }
}

Valeurs de propriété

Microsoft.Synapse/workspaces/integrationRuntimes

CmdkeySetup

CmdkeySetupTypeProperties

ComponentSetup

CustomSetupBase

EntityReference

EnvironmentVariableSetup

EnvironmentVariableSetupTypeProperties

IntegrationRuntime

IntegrationRuntimeComputeProperties

IntegrationRuntimeCustomerVirtualNetwork

IntegrationRuntimeCustomSetupScriptProperties

IntegrationRuntimeDataFlowProperties

IntegrationRuntimeDataProxyProperties

IntegrationRuntimeSsisCatalogInfo

IntegrationRuntimeSsisProperties

IntegrationRuntimeVNetProperties

LicensedComponentSetupTypeProperties

LinkedIntegrationRuntimeKeyAuthorization

LinkedIntegrationRuntimeRbacAuthorization

LinkedIntegrationRuntimeType

ManagedIntegrationRuntime

ManagedIntegrationRuntimeManagedVirtualNetworkReference

ManagedIntegrationRuntimeTypeProperties

SecretBase

SecureString

SecureString

SelfHostedIntegrationRuntime

SelfHostedIntegrationRuntimeTypeProperties

Définition de ressource de modèle ARM

Le type de ressource workspaces/integrationRuntimes peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Synapse/workspaces/integrationRuntimes, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Synapse/workspaces/integrationRuntimes",
  "apiVersion": "2021-06-01",
  "name": "string",
  "properties": {
    "description": "string",
    "type": "string"
    // For remaining properties, see IntegrationRuntime objects
  }
}

Objets SecretBase

Définissez le type propriété pour spécifier le type d’objet.

Pour SecureString, utilisez :

{
  "type": "SecureString",
  "value": "string"
}

Objets LinkedIntegrationRuntimeType

Définissez la propriété authorizationType pour spécifier le type d’objet.

Pour Key, utilisez :

{
  "authorizationType": "Key",
  "key": {
    "type": "string",
    "value": "string"
  }
}

Pour le RBAC, utilisez :

{
  "authorizationType": "RBAC",
  "resourceId": "string"
}

Objets IntegrationRuntime

Définissez le type propriété pour spécifier le type d’objet.

Pour Managed, utilisez :

{
  "managedVirtualNetwork": {
    "id": "string",
    "referenceName": "string",
    "type": "string"
  },
  "type": "Managed",
  "typeProperties": {
    "computeProperties": {
      "dataFlowProperties": {
        "computeType": "string",
        "coreCount": "int",
        "timeToLive": "int"
      },
      "location": "string",
      "maxParallelExecutionsPerNode": "int",
      "nodeSize": "string",
      "numberOfNodes": "int",
      "vNetProperties": {
        "publicIPs": [ "string" ],
        "subnet": "string",
        "subnetId": "string",
        "vNetId": "string"
      }
    },
    "customerVirtualNetwork": {
      "subnetId": "string"
    },
    "ssisProperties": {
      "catalogInfo": {
        "catalogAdminPassword": {
          "type": "string",
          "value": "string"
        },
        "catalogAdminUserName": "string",
        "catalogPricingTier": "string",
        "catalogServerEndpoint": "string"
      },
      "customSetupScriptProperties": {
        "blobContainerUri": "string",
        "sasToken": {
          "type": "string",
          "value": "string"
        }
      },
      "dataProxyProperties": {
        "connectVia": {
          "referenceName": "string",
          "type": "string"
        },
        "path": "string",
        "stagingLinkedService": {
          "referenceName": "string",
          "type": "string"
        }
      },
      "edition": "string",
      "expressCustomSetupProperties": [ {
        "type": "string"
        // For remaining properties, see CustomSetupBase objects
      } ],
      "licenseType": "string"
    }
  }
}

Pour SelfHosted, utilisez :

{
  "type": "SelfHosted",
  "typeProperties": {
    "linkedInfo": {
      "authorizationType": "string"
      // For remaining properties, see LinkedIntegrationRuntimeType objects
    }
  }
}

Objets CustomSetupBase

Définissez le type propriété pour spécifier le type d’objet.

Pour CmdkeySetup, utilisez :

{
  "type": "CmdkeySetup",
  "typeProperties": {
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "targetName": {},
    "userName": {}
  }
}

Pour ComponentSetup, utilisez :

{
  "type": "ComponentSetup",
  "typeProperties": {
    "componentName": "string",
    "licenseKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    }
  }
}

Pour EnvironmentVariableSetup, utilisez :

{
  "type": "EnvironmentVariableSetup",
  "typeProperties": {
    "variableName": "string",
    "variableValue": "string"
  }
}

Valeurs de propriété

Microsoft.Synapse/workspaces/integrationRuntimes

CmdkeySetup

CmdkeySetupTypeProperties

ComponentSetup

CustomSetupBase

EntityReference

EnvironmentVariableSetup

EnvironmentVariableSetupTypeProperties

IntegrationRuntime

IntegrationRuntimeComputeProperties

IntegrationRuntimeCustomerVirtualNetwork

IntegrationRuntimeCustomSetupScriptProperties

IntegrationRuntimeDataFlowProperties

IntegrationRuntimeDataProxyProperties

IntegrationRuntimeSsisCatalogInfo

IntegrationRuntimeSsisProperties

IntegrationRuntimeVNetProperties

LicensedComponentSetupTypeProperties

LinkedIntegrationRuntimeKeyAuthorization

LinkedIntegrationRuntimeRbacAuthorization

LinkedIntegrationRuntimeType

ManagedIntegrationRuntime

ManagedIntegrationRuntimeManagedVirtualNetworkReference

ManagedIntegrationRuntimeTypeProperties

SecretBase

SecureString

SecureString

SelfHostedIntegrationRuntime

SelfHostedIntegrationRuntimeTypeProperties

Exemples d’utilisation

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource workspaces/integrationRuntimes peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Synapse/workspaces/integrationRuntimes, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      type = "string"
      // For remaining properties, see IntegrationRuntime objects
    }
  }
}

Objets SecretBase

Définissez le type propriété pour spécifier le type d’objet.

Pour SecureString, utilisez :

{
  type = "SecureString"
  value = "string"
}

Objets LinkedIntegrationRuntimeType

Définissez la propriété authorizationType pour spécifier le type d’objet.

Pour Key, utilisez :

{
  authorizationType = "Key"
  key = {
    type = "string"
    value = "string"
  }
}

Pour le RBAC, utilisez :

{
  authorizationType = "RBAC"
  resourceId = "string"
}

Objets IntegrationRuntime

Définissez le type propriété pour spécifier le type d’objet.

Pour Managed, utilisez :

{
  managedVirtualNetwork = {
    id = "string"
    referenceName = "string"
    type = "string"
  }
  type = "Managed"
  typeProperties = {
    computeProperties = {
      dataFlowProperties = {
        computeType = "string"
        coreCount = int
        timeToLive = int
      }
      location = "string"
      maxParallelExecutionsPerNode = int
      nodeSize = "string"
      numberOfNodes = int
      vNetProperties = {
        publicIPs = [
          "string"
        ]
        subnet = "string"
        subnetId = "string"
        vNetId = "string"
      }
    }
    customerVirtualNetwork = {
      subnetId = "string"
    }
    ssisProperties = {
      catalogInfo = {
        catalogAdminPassword = {
          type = "string"
          value = "string"
        }
        catalogAdminUserName = "string"
        catalogPricingTier = "string"
        catalogServerEndpoint = "string"
      }
      customSetupScriptProperties = {
        blobContainerUri = "string"
        sasToken = {
          type = "string"
          value = "string"
        }
      }
      dataProxyProperties = {
        connectVia = {
          referenceName = "string"
          type = "string"
        }
        path = "string"
        stagingLinkedService = {
          referenceName = "string"
          type = "string"
        }
      }
      edition = "string"
      expressCustomSetupProperties = [
        {
          type = "string"
          // For remaining properties, see CustomSetupBase objects
        }
      ]
      licenseType = "string"
    }
  }
}

Pour SelfHosted, utilisez :

{
  type = "SelfHosted"
  typeProperties = {
    linkedInfo = {
      authorizationType = "string"
      // For remaining properties, see LinkedIntegrationRuntimeType objects
    }
  }
}

Objets CustomSetupBase

Définissez le type propriété pour spécifier le type d’objet.

Pour CmdkeySetup, utilisez :

{
  type = "CmdkeySetup"
  typeProperties = {
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    targetName = ?
    userName = ?
  }
}

Pour ComponentSetup, utilisez :

{
  type = "ComponentSetup"
  typeProperties = {
    componentName = "string"
    licenseKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }
}

Pour EnvironmentVariableSetup, utilisez :

{
  type = "EnvironmentVariableSetup"
  typeProperties = {
    variableName = "string"
    variableValue = "string"
  }
}

Valeurs de propriété

Microsoft.Synapse/workspaces/integrationRuntimes

CmdkeySetup

CmdkeySetupTypeProperties

ComponentSetup

CustomSetupBase

EntityReference

EnvironmentVariableSetup

EnvironmentVariableSetupTypeProperties

IntegrationRuntime

IntegrationRuntimeComputeProperties

IntegrationRuntimeCustomerVirtualNetwork

IntegrationRuntimeCustomSetupScriptProperties

IntegrationRuntimeDataFlowProperties

IntegrationRuntimeDataProxyProperties

IntegrationRuntimeSsisCatalogInfo

IntegrationRuntimeSsisProperties

IntegrationRuntimeVNetProperties

LicensedComponentSetupTypeProperties

LinkedIntegrationRuntimeKeyAuthorization

LinkedIntegrationRuntimeRbacAuthorization

LinkedIntegrationRuntimeType

ManagedIntegrationRuntime

ManagedIntegrationRuntimeManagedVirtualNetworkReference

ManagedIntegrationRuntimeTypeProperties

SecretBase

SecureString

SecureString

SelfHostedIntegrationRuntime

SelfHostedIntegrationRuntimeTypeProperties

Exemples d’utilisation

Échantillons Terraform

Exemple de base de déploiement de Synapse Azure Integration Runtime.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

variable "sql_administrator_login" {
  type        = string
  description = "The SQL administrator login for the Synapse workspace"
}

variable "sql_administrator_login_password" {
  type        = string
  description = "The SQL administrator login password for the Synapse workspace"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_resource_action" "listKeys" {
  type                   = "Microsoft.Storage/storageAccounts@2022-09-01"
  resource_id            = azapi_resource.storageAccount.id
  action                 = "listKeys"
  response_export_values = ["*"]
}

data "azapi_resource" "blobService" {
  type      = "Microsoft.Storage/storageAccounts/blobServices@2022-09-01"
  parent_id = azapi_resource.storageAccount.id
  name      = "default"
}

resource "azapi_resource" "container" {
  type      = "Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01"
  name      = var.resource_name
  parent_id = data.azapi_resource.blobService.id
  body = {
    properties = {
      metadata = {
        key = "value"
      }
    }
  }
  response_export_values = ["*"]
}

resource "azapi_resource" "workspace" {
  type      = "Microsoft.Synapse/workspaces@2021-06-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      defaultDataLakeStorage = {
        accountUrl = azapi_resource.storageAccount.output.properties.primaryEndpoints.dfs
        filesystem = azapi_resource.container.name
      }

      managedVirtualNetwork         = "default"
      publicNetworkAccess           = "Enabled"
      sqlAdministratorLogin         = var.sql_administrator_login
      sqlAdministratorLoginPassword = var.sql_administrator_login_password
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "integrationRuntime" {
  type      = "Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01-preview"
  parent_id = azapi_resource.workspace.id
  name      = var.resource_name
  body = {
    properties = {
      description = "test"
      type        = "SelfHosted"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}