Microsoft. Espaços de trabalho/integraçãoRuntimes do Synapse

Definição de recurso Bicep

O tipo de recurso workspaces/integrationRuntimes pode ser implantado com operações que visam:

• Resource groups - Ver comandos de implementação resource groups

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar uma Microsoft. Recurso Synapse/workspaces/integrationRuntimes, adicione o seguinte Bicep ao seu modelo.

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

Objetos SecretBase

Defina a propriedade type para especificar o tipo de objeto.

Para SecureString, use:

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

Objetos LinkedIntegrationRuntimeType

Defina a propriedade authorizationType para especificar o tipo de objeto.

Para Key, use:

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

Para RBAC, use:

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

Objetos CustomSetupBase

Defina a propriedade type para especificar o tipo de objeto.

Para CmdkeySetup, use:

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

Para ComponentSetup, use:

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

Para EnvironmentVariableSetup, use:

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

Objetos IntegrationRuntime

Defina a propriedade type para especificar o tipo de objeto.

Para Gerenciado, use:

{
  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'
    }
  }
}

Para SelfHosted, use:

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

Valores de propriedade

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

Exemplos de uso

Amostras de Bicep

Um exemplo básico de implementação do Synapse Azure Integration Runtime.

param resourceName string = 'acctest0001'
param location string = 'westeurope'
@description('The SQL administrator login for the Synapse workspace')
param sqlAdministratorLogin string
@secure()
@description('The SQL administrator login password for the Synapse workspace')
param sqlAdministratorLoginPassword string

resource blobService 'Microsoft.Storage/storageAccounts/blobServices@2022-09-01' existing = {
  parent: storageAccount
  name: 'default'
}

resource storageAccount 'Microsoft.Storage/storageAccounts@2021-09-01' = {
  name: resourceName
  location: location
  kind: 'StorageV2'
  properties: {}
  sku: {
    name: 'Standard_LRS'
  }
}

resource workspace 'Microsoft.Synapse/workspaces@2021-06-01' = {
  name: resourceName
  location: location
  properties: {
    defaultDataLakeStorage: {
      accountUrl: storageAccount.properties.primaryEndpoints.dfs
      filesystem: container.name
    }

    managedVirtualNetwork: 'default'
    publicNetworkAccess: 'Enabled'
    sqlAdministratorLogin: sqlAdministratorLogin
    sqlAdministratorLoginPassword: sqlAdministratorLoginPassword
  }
}

resource integrationRuntime 'Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01-preview' = {
  parent: workspace
  name: resourceName
  properties: {
    description: 'test'
    type: 'SelfHosted'
  }
}

resource container 'Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01' = {
  parent: blobService
  name: resourceName
  properties: {
    metadata: {
      key: 'value'
    }
  }
}

Definição de recurso de modelo ARM

O tipo de recurso workspaces/integrationRuntimes pode ser implantado com operações que visam:

• Resource groups - Ver comandos de implementação resource groups

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar uma Microsoft. Synapse/workspaces/integrationRuntimes, adicione o seguinte JSON ao seu modelo.

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

Objetos SecretBase

Defina a propriedade type para especificar o tipo de objeto.

Para SecureString, use:

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

Objetos LinkedIntegrationRuntimeType

Defina a propriedade authorizationType para especificar o tipo de objeto.

Para Key, use:

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

Para RBAC, use:

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

Objetos CustomSetupBase

Defina a propriedade type para especificar o tipo de objeto.

Para CmdkeySetup, use:

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

Para ComponentSetup, use:

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

Para EnvironmentVariableSetup, use:

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

Objetos IntegrationRuntime

Defina a propriedade type para especificar o tipo de objeto.

Para Gerenciado, use:

{
  "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"
    }
  }
}

Para SelfHosted, use:

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

Valores de propriedade

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

Exemplos de uso

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso workspaces/integrationRuntimes pode ser implantado com operações que visam:

• Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar uma Microsoft. Synapse/workspaces/integrationRuntimes, adicione o seguinte Terraform ao seu modelo.

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
    }
  }
}

Objetos SecretBase

Defina a propriedade type para especificar o tipo de objeto.

Para SecureString, use:

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

Objetos LinkedIntegrationRuntimeType

Defina a propriedade authorizationType para especificar o tipo de objeto.

Para Key, use:

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

Para RBAC, use:

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

Objetos CustomSetupBase

Defina a propriedade type para especificar o tipo de objeto.

Para CmdkeySetup, use:

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

Para ComponentSetup, use:

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

Para EnvironmentVariableSetup, use:

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

Objetos IntegrationRuntime

Defina a propriedade type para especificar o tipo de objeto.

Para Gerenciado, use:

{
  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"
    }
  }
}

Para SelfHosted, use:

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

Valores de propriedade

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

Exemplos de uso

Amostras Terraform

Um exemplo básico de implementação do 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    = ["*"]
}