Compartir a través de

Áreas de trabajo de Microsoft.Synapse/integrationRuntimes 2020-12-01

  • Artículo

Definición de recursos de Bicep

El tipo de recurso workspaces/integrationRuntimes se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Synapse/workspaces/integrationRuntimes, agregue el siguiente bicep a la plantilla.

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

Objetos SecretBase

Establezca el tipo propiedad para especificar el tipo de objeto.

Para SecureString, use:

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

Objetos CustomSetupBase

Establezca el tipo propiedad para especificar el tipo de objeto.

Para CmdkeySetup, use:

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

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

IntegrationRuntime (objetos)

Establezca el tipo propiedad para especificar el tipo de objeto.

Para managed, use:

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

Objetos LinkedIntegrationRuntimeType

Establezca la propiedad authorizationType para especificar el tipo de objeto.

Para Key, use:

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

Para RBAC, use:

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

Valores de propiedad

CmdkeySetup

Nombre Descripción Valor
tipo Tipo de configuración personalizada. 'CmdkeySetup' (obligatorio)
typeProperties Propiedades del tipo de instalación personalizada del comando Cmdkey. cmdkeySetupTypeProperties (obligatorio)

CmdkeySetupTypeProperties

Nombre Descripción Valor
contraseña Contraseña del acceso al origen de datos. SecretBase (obligatorio)
targetName Nombre del servidor del acceso al origen de datos. any (obligatorio)
nombre de usuario Nombre de usuario del acceso al origen de datos. any (obligatorio)

ComponentSetup

Nombre Descripción Valor
tipo Tipo de configuración personalizada. 'ComponentSetup' (obligatorio)
typeProperties Instale las propiedades de tipo de componente de terceros. licensedComponentSetupTypeProperties (obligatorio)

CustomSetupBase

Nombre Descripción Valor
tipo Establezca en "CmdkeySetup" para el tipo CmdkeySetup. Establezca en "ComponentSetup" para el tipo ComponentSetup. Establezca en "EnvironmentVariableSetup" para el tipo EnvironmentVariableSetup. 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (obligatorio)

EntityReference

Nombre Descripción Valor
referenceName Nombre de esta entidad a la que se hace referencia. cuerda
tipo Tipo de esta entidad a la que se hace referencia. 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Nombre Descripción Valor
tipo Tipo de configuración personalizada. 'EnvironmentVariableSetup' (obligatorio)
typeProperties Agregue propiedades de tipo de variable de entorno. EnvironmentVariableSetupTypeProperties (obligatorio)

EnvironmentVariableSetupTypeProperties

Nombre Descripción Valor
variableName Nombre de la variable de entorno. string (obligatorio)
variableValue Valor de la variable de entorno. string (obligatorio)

IntegrationRuntime

Nombre Descripción Valor
descripción Descripción del entorno de ejecución de integración. cuerda
tipo Establezca en "Administrado" para el tipo ManagedIntegrationRuntime. Establezca en "SelfHosted" para el tipo SelfHostedIntegrationRuntime. "Administrado"
'SelfHosted' (obligatorio)

IntegrationRuntimeComputeProperties

Nombre Descripción Valor
dataFlowProperties Propiedades de flujo de datos para el entorno de ejecución de integración administrado. IntegrationRuntimeDataFlowProperties
ubicación Ubicación del entorno de ejecución de integración administrado. Las regiones admitidas se pueden encontrar en /azure/data-factory/data-factory-data-movement-activities cuerda
maxParallelExecutionsPerNode Número máximo de ejecuciones paralelas por nodo para el entorno de ejecución de integración administrado. Int

Restricciones:
Valor mínimo = 1
nodeSize Requisito de tamaño de nodo para el entorno de ejecución de integración administrado. cuerda
numberOfNodes El número necesario de nodos para el entorno de ejecución de integración administrado. Int

Restricciones:
Valor mínimo = 1
vNetProperties Propiedades de red virtual para el entorno de ejecución de integración administrado. IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomSetupScriptProperties

Nombre Descripción Valor
blobContainerUri URI del contenedor de blobs de Azure que contiene el script de instalación personalizado. cuerda
sasToken Token de SAS del contenedor de blobs de Azure. SecureString

IntegrationRuntimeDataFlowProperties

Nombre Descripción Valor
computeType Tipo de proceso del clúster que ejecutará el trabajo de flujo de datos. "ComputeOptimized"
"General"
'MemoryOptimized'
coreCount Recuento básico del clúster que ejecutará el trabajo de flujo de datos. Los valores admitidos son: 8, 16, 32, 48, 80, 144 y 272. Int
timeToLive Configuración de período de vida (en minutos) del clúster que ejecutará el trabajo de flujo de datos. Int

Restricciones:
Valor mínimo = 0

IntegrationRuntimeDataProxyProperties

Nombre Descripción Valor
connectVia Referencia del entorno de ejecución de integración autohospedado. EntityReference
camino Ruta de acceso que contiene los datos almacenados provisionalmente en Blob Storage. cuerda
stagingLinkedService Referencia del servicio vinculado de almacenamiento provisional. EntityReference

IntegrationRuntimeSsisCatalogInfo

Nombre Descripción Valor
catalogAdminPassword Contraseña de la cuenta de usuario administrador de la base de datos del catálogo. SecureString
catalogAdminUserName Nombre de usuario de administrador de la base de datos de catálogo. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 128
catalogPricingTier Plan de tarifa de la base de datos de catálogo. Los valores válidos se pueden encontrar en https://azure.microsoft.com/en-us/pricing/details/sql-database/ "Básico"
'Premium'
'PremiumRS'
'Estándar'
catalogServerEndpoint Dirección URL del servidor de base de datos del catálogo. cuerda

IntegrationRuntimeSsisProperties

Nombre Descripción Valor
catalogInfo Información del catálogo para el entorno de ejecución de integración dedicado administrado. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Propiedades del script de instalación personalizada para un entorno de ejecución de integración dedicado administrado. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Propiedades de proxy de datos para un entorno de ejecución de integración dedicado administrado. IntegrationRuntimeDataProxyProperties
edición Edición de SSIS Integration Runtime "Enterprise"
'Estándar'
expressCustomSetupProperties Configuración personalizada sin propiedades de script para un entorno de ejecución de integración de SSIS. CustomSetupBase []
licenseType Tipo de licencia para traer su propio escenario de licencia. 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Nombre Descripción Valor
publicIPs Identificadores de recursos de las direcciones IP públicas que usará este entorno de ejecución de integración. string[]
subred Nombre de la subred a la que se unirá este entorno de ejecución de integración. cuerda
subnetId El identificador de la subred, al que se unirá este Azure-SSIS integration Runtime. cuerda
vNetId Identificador de la red virtual a la que se unirá este entorno de ejecución de integración. cuerda

LicensedComponentSetupTypeProperties

Nombre Descripción Valor
componentName Nombre del componente de terceros. string (obligatorio)
licenseKey Clave de licencia para activar el componente. SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Nombre Descripción Valor
authorizationType Tipo de autorización para el uso compartido de Integration Runtime. 'Key' (obligatorio)
llave Clave que se usa para la autorización. SecureString (obligatorio)

LinkedIntegrationRuntimeRbacAuthorization

Nombre Descripción Valor
authorizationType Tipo de autorización para el uso compartido de Integration Runtime. 'RBAC' (obligatorio)
resourceId Identificador de recurso del entorno de ejecución de integración que se va a compartir. string (obligatorio)

LinkedIntegrationRuntimeType

Nombre Descripción Valor
authorizationType Establezca en "Key" para el tipo LinkedIntegrationRuntimeKeyAuthorization. Establezca en "RBAC" para el tipo LinkedIntegrationRuntimeRbacAuthorization. 'Clave'
'RBAC' (obligatorio)

ManagedIntegrationRuntime

Nombre Descripción Valor
tipo Tipo de entorno de ejecución de integración. "Administrado" (obligatorio)
typeProperties Propiedades del entorno de ejecución de integración administrada. ManagedIntegrationRuntimeTypeProperties (obligatorio)

ManagedIntegrationRuntimeTypeProperties

Nombre Descripción Valor
computeProperties Recurso de proceso para el entorno de ejecución de integración administrado. IntegrationRuntimeComputeProperties
ssisProperties Propiedades de SSIS para el entorno de ejecución de integración administrado. IntegrationRuntimeSsisProperties

Microsoft.Synapse/workspaces/integrationRuntimes

Nombre Descripción Valor
nombre El nombre del recurso string (obligatorio)
padre En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: áreas de trabajo
Propiedades Propiedades de Integration Runtime. IntegrationRuntime (obligatorio)

SecretBase

Nombre Descripción Valor
tipo Establezca en "SecureString" para el tipo SecureString. "SecureString" (obligatorio)

SecureString

Nombre Descripción Valor
tipo Tipo del secreto. string (obligatorio)
valor Valor de cadena segura. string (obligatorio)

SecureString

Nombre Descripción Valor
tipo Tipo del secreto. "SecureString" (obligatorio)
valor Valor de cadena segura. string (obligatorio)

SelfHostedIntegrationRuntime

Nombre Descripción Valor
tipo Tipo de entorno de ejecución de integración. 'SelfHosted' (obligatorio)
typeProperties Cuando esta propiedad no es null, significa que se trata de un entorno de ejecución de integración vinculado. La propiedad se usa para acceder al entorno de ejecución de integración original. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Nombre Descripción Valor
linkedInfo Tipo de entorno de ejecución de integración vinculado de Data Factory LinkedIntegrationRuntimeType

Definición de recursos de plantilla de ARM

El tipo de recurso workspaces/integrationRuntimes se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Synapse/workspaces/integrationRuntimes, agregue el siguiente JSON a la plantilla.

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

Objetos SecretBase

Establezca el tipo propiedad para especificar el tipo de objeto.

Para SecureString, use:

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

Objetos CustomSetupBase

Establezca el tipo propiedad para especificar el 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"
  }
}

IntegrationRuntime (objetos)

Establezca el tipo propiedad para especificar el tipo de objeto.

Para managed, use:

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

Objetos LinkedIntegrationRuntimeType

Establezca la propiedad authorizationType para especificar el tipo de objeto.

Para Key, use:

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

Para RBAC, use:

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

Valores de propiedad

CmdkeySetup

Nombre Descripción Valor
tipo Tipo de configuración personalizada. 'CmdkeySetup' (obligatorio)
typeProperties Propiedades del tipo de instalación personalizada del comando Cmdkey. cmdkeySetupTypeProperties (obligatorio)

CmdkeySetupTypeProperties

Nombre Descripción Valor
contraseña Contraseña del acceso al origen de datos. SecretBase (obligatorio)
targetName Nombre del servidor del acceso al origen de datos. any (obligatorio)
nombre de usuario Nombre de usuario del acceso al origen de datos. any (obligatorio)

ComponentSetup

Nombre Descripción Valor
tipo Tipo de configuración personalizada. 'ComponentSetup' (obligatorio)
typeProperties Instale las propiedades de tipo de componente de terceros. licensedComponentSetupTypeProperties (obligatorio)

CustomSetupBase

Nombre Descripción Valor
tipo Establezca en "CmdkeySetup" para el tipo CmdkeySetup. Establezca en "ComponentSetup" para el tipo ComponentSetup. Establezca en "EnvironmentVariableSetup" para el tipo EnvironmentVariableSetup. 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (obligatorio)

EntityReference

Nombre Descripción Valor
referenceName Nombre de esta entidad a la que se hace referencia. cuerda
tipo Tipo de esta entidad a la que se hace referencia. 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Nombre Descripción Valor
tipo Tipo de configuración personalizada. 'EnvironmentVariableSetup' (obligatorio)
typeProperties Agregue propiedades de tipo de variable de entorno. EnvironmentVariableSetupTypeProperties (obligatorio)

EnvironmentVariableSetupTypeProperties

Nombre Descripción Valor
variableName Nombre de la variable de entorno. string (obligatorio)
variableValue Valor de la variable de entorno. string (obligatorio)

IntegrationRuntime

Nombre Descripción Valor
descripción Descripción del entorno de ejecución de integración. cuerda
tipo Establezca en "Administrado" para el tipo ManagedIntegrationRuntime. Establezca en "SelfHosted" para el tipo SelfHostedIntegrationRuntime. "Administrado"
'SelfHosted' (obligatorio)

IntegrationRuntimeComputeProperties

Nombre Descripción Valor
dataFlowProperties Propiedades de flujo de datos para el entorno de ejecución de integración administrado. IntegrationRuntimeDataFlowProperties
ubicación Ubicación del entorno de ejecución de integración administrado. Las regiones admitidas se pueden encontrar en /azure/data-factory/data-factory-data-movement-activities cuerda
maxParallelExecutionsPerNode Número máximo de ejecuciones paralelas por nodo para el entorno de ejecución de integración administrado. Int

Restricciones:
Valor mínimo = 1
nodeSize Requisito de tamaño de nodo para el entorno de ejecución de integración administrado. cuerda
numberOfNodes El número necesario de nodos para el entorno de ejecución de integración administrado. Int

Restricciones:
Valor mínimo = 1
vNetProperties Propiedades de red virtual para el entorno de ejecución de integración administrado. IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomSetupScriptProperties

Nombre Descripción Valor
blobContainerUri URI del contenedor de blobs de Azure que contiene el script de instalación personalizado. cuerda
sasToken Token de SAS del contenedor de blobs de Azure. SecureString

IntegrationRuntimeDataFlowProperties

Nombre Descripción Valor
computeType Tipo de proceso del clúster que ejecutará el trabajo de flujo de datos. "ComputeOptimized"
"General"
'MemoryOptimized'
coreCount Recuento básico del clúster que ejecutará el trabajo de flujo de datos. Los valores admitidos son: 8, 16, 32, 48, 80, 144 y 272. Int
timeToLive Configuración de período de vida (en minutos) del clúster que ejecutará el trabajo de flujo de datos. Int

Restricciones:
Valor mínimo = 0

IntegrationRuntimeDataProxyProperties

Nombre Descripción Valor
connectVia Referencia del entorno de ejecución de integración autohospedado. EntityReference
camino Ruta de acceso que contiene los datos almacenados provisionalmente en Blob Storage. cuerda
stagingLinkedService Referencia del servicio vinculado de almacenamiento provisional. EntityReference

IntegrationRuntimeSsisCatalogInfo

Nombre Descripción Valor
catalogAdminPassword Contraseña de la cuenta de usuario administrador de la base de datos del catálogo. SecureString
catalogAdminUserName Nombre de usuario de administrador de la base de datos de catálogo. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 128
catalogPricingTier Plan de tarifa de la base de datos de catálogo. Los valores válidos se pueden encontrar en https://azure.microsoft.com/en-us/pricing/details/sql-database/ "Básico"
'Premium'
'PremiumRS'
'Estándar'
catalogServerEndpoint Dirección URL del servidor de base de datos del catálogo. cuerda

IntegrationRuntimeSsisProperties

Nombre Descripción Valor
catalogInfo Información del catálogo para el entorno de ejecución de integración dedicado administrado. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Propiedades del script de instalación personalizada para un entorno de ejecución de integración dedicado administrado. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Propiedades de proxy de datos para un entorno de ejecución de integración dedicado administrado. IntegrationRuntimeDataProxyProperties
edición Edición de SSIS Integration Runtime "Enterprise"
'Estándar'
expressCustomSetupProperties Configuración personalizada sin propiedades de script para un entorno de ejecución de integración de SSIS. CustomSetupBase []
licenseType Tipo de licencia para traer su propio escenario de licencia. 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Nombre Descripción Valor
publicIPs Identificadores de recursos de las direcciones IP públicas que usará este entorno de ejecución de integración. string[]
subred Nombre de la subred a la que se unirá este entorno de ejecución de integración. cuerda
subnetId El identificador de la subred, al que se unirá este Azure-SSIS integration Runtime. cuerda
vNetId Identificador de la red virtual a la que se unirá este entorno de ejecución de integración. cuerda

LicensedComponentSetupTypeProperties

Nombre Descripción Valor
componentName Nombre del componente de terceros. string (obligatorio)
licenseKey Clave de licencia para activar el componente. SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Nombre Descripción Valor
authorizationType Tipo de autorización para el uso compartido de Integration Runtime. 'Key' (obligatorio)
llave Clave que se usa para la autorización. SecureString (obligatorio)

LinkedIntegrationRuntimeRbacAuthorization

Nombre Descripción Valor
authorizationType Tipo de autorización para el uso compartido de Integration Runtime. 'RBAC' (obligatorio)
resourceId Identificador de recurso del entorno de ejecución de integración que se va a compartir. string (obligatorio)

LinkedIntegrationRuntimeType

Nombre Descripción Valor
authorizationType Establezca en "Key" para el tipo LinkedIntegrationRuntimeKeyAuthorization. Establezca en "RBAC" para el tipo LinkedIntegrationRuntimeRbacAuthorization. 'Clave'
'RBAC' (obligatorio)

ManagedIntegrationRuntime

Nombre Descripción Valor
tipo Tipo de entorno de ejecución de integración. "Administrado" (obligatorio)
typeProperties Propiedades del entorno de ejecución de integración administrada. ManagedIntegrationRuntimeTypeProperties (obligatorio)

ManagedIntegrationRuntimeTypeProperties

Nombre Descripción Valor
computeProperties Recurso de proceso para el entorno de ejecución de integración administrado. IntegrationRuntimeComputeProperties
ssisProperties Propiedades de SSIS para el entorno de ejecución de integración administrado. IntegrationRuntimeSsisProperties

Microsoft.Synapse/workspaces/integrationRuntimes

Nombre Descripción Valor
apiVersion La versión de api '2020-12-01'
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades de Integration Runtime. IntegrationRuntime (obligatorio)
tipo El tipo de recurso "Microsoft.Synapse/workspaces/integrationRuntimes"

SecretBase

Nombre Descripción Valor
tipo Establezca en "SecureString" para el tipo SecureString. "SecureString" (obligatorio)

SecureString

Nombre Descripción Valor
tipo Tipo del secreto. string (obligatorio)
valor Valor de cadena segura. string (obligatorio)

SecureString

Nombre Descripción Valor
tipo Tipo del secreto. "SecureString" (obligatorio)
valor Valor de cadena segura. string (obligatorio)

SelfHostedIntegrationRuntime

Nombre Descripción Valor
tipo Tipo de entorno de ejecución de integración. 'SelfHosted' (obligatorio)
typeProperties Cuando esta propiedad no es null, significa que se trata de un entorno de ejecución de integración vinculado. La propiedad se usa para acceder al entorno de ejecución de integración original. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Nombre Descripción Valor
linkedInfo Tipo de entorno de ejecución de integración vinculado de Data Factory LinkedIntegrationRuntimeType

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso workspaces/integrationRuntimes se puede implementar con operaciones destinadas a:

  • grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Synapse/workspaces/integrationRuntimes, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/integrationRuntimes@2020-12-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      type = "string"
      // For remaining properties, see IntegrationRuntime objects
    }
  })
}

Objetos SecretBase

Establezca el tipo propiedad para especificar el tipo de objeto.

Para SecureString, use:

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

Objetos CustomSetupBase

Establezca el tipo propiedad para especificar el 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"
  }
}

IntegrationRuntime (objetos)

Establezca el tipo propiedad para especificar el tipo de objeto.

Para managed, use:

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

Objetos LinkedIntegrationRuntimeType

Establezca la propiedad authorizationType para especificar el tipo de objeto.

Para Key, use:

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

Para RBAC, use:

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

Valores de propiedad

CmdkeySetup

Nombre Descripción Valor
tipo Tipo de configuración personalizada. 'CmdkeySetup' (obligatorio)
typeProperties Propiedades del tipo de instalación personalizada del comando Cmdkey. cmdkeySetupTypeProperties (obligatorio)

CmdkeySetupTypeProperties

Nombre Descripción Valor
contraseña Contraseña del acceso al origen de datos. SecretBase (obligatorio)
targetName Nombre del servidor del acceso al origen de datos. any (obligatorio)
nombre de usuario Nombre de usuario del acceso al origen de datos. any (obligatorio)

ComponentSetup

Nombre Descripción Valor
tipo Tipo de configuración personalizada. 'ComponentSetup' (obligatorio)
typeProperties Instale las propiedades de tipo de componente de terceros. licensedComponentSetupTypeProperties (obligatorio)

CustomSetupBase

Nombre Descripción Valor
tipo Establezca en "CmdkeySetup" para el tipo CmdkeySetup. Establezca en "ComponentSetup" para el tipo ComponentSetup. Establezca en "EnvironmentVariableSetup" para el tipo EnvironmentVariableSetup. 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (obligatorio)

EntityReference

Nombre Descripción Valor
referenceName Nombre de esta entidad a la que se hace referencia. cuerda
tipo Tipo de esta entidad a la que se hace referencia. 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Nombre Descripción Valor
tipo Tipo de configuración personalizada. 'EnvironmentVariableSetup' (obligatorio)
typeProperties Agregue propiedades de tipo de variable de entorno. EnvironmentVariableSetupTypeProperties (obligatorio)

EnvironmentVariableSetupTypeProperties

Nombre Descripción Valor
variableName Nombre de la variable de entorno. string (obligatorio)
variableValue Valor de la variable de entorno. string (obligatorio)

IntegrationRuntime

Nombre Descripción Valor
descripción Descripción del entorno de ejecución de integración. cuerda
tipo Establezca en "Administrado" para el tipo ManagedIntegrationRuntime. Establezca en "SelfHosted" para el tipo SelfHostedIntegrationRuntime. "Administrado"
'SelfHosted' (obligatorio)

IntegrationRuntimeComputeProperties

Nombre Descripción Valor
dataFlowProperties Propiedades de flujo de datos para el entorno de ejecución de integración administrado. IntegrationRuntimeDataFlowProperties
ubicación Ubicación del entorno de ejecución de integración administrado. Las regiones admitidas se pueden encontrar en /azure/data-factory/data-factory-data-movement-activities cuerda
maxParallelExecutionsPerNode Número máximo de ejecuciones paralelas por nodo para el entorno de ejecución de integración administrado. Int

Restricciones:
Valor mínimo = 1
nodeSize Requisito de tamaño de nodo para el entorno de ejecución de integración administrado. cuerda
numberOfNodes El número necesario de nodos para el entorno de ejecución de integración administrado. Int

Restricciones:
Valor mínimo = 1
vNetProperties Propiedades de red virtual para el entorno de ejecución de integración administrado. IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomSetupScriptProperties

Nombre Descripción Valor
blobContainerUri URI del contenedor de blobs de Azure que contiene el script de instalación personalizado. cuerda
sasToken Token de SAS del contenedor de blobs de Azure. SecureString

IntegrationRuntimeDataFlowProperties

Nombre Descripción Valor
computeType Tipo de proceso del clúster que ejecutará el trabajo de flujo de datos. "ComputeOptimized"
"General"
'MemoryOptimized'
coreCount Recuento básico del clúster que ejecutará el trabajo de flujo de datos. Los valores admitidos son: 8, 16, 32, 48, 80, 144 y 272. Int
timeToLive Configuración de período de vida (en minutos) del clúster que ejecutará el trabajo de flujo de datos. Int

Restricciones:
Valor mínimo = 0

IntegrationRuntimeDataProxyProperties

Nombre Descripción Valor
connectVia Referencia del entorno de ejecución de integración autohospedado. EntityReference
camino Ruta de acceso que contiene los datos almacenados provisionalmente en Blob Storage. cuerda
stagingLinkedService Referencia del servicio vinculado de almacenamiento provisional. EntityReference

IntegrationRuntimeSsisCatalogInfo

Nombre Descripción Valor
catalogAdminPassword Contraseña de la cuenta de usuario administrador de la base de datos del catálogo. SecureString
catalogAdminUserName Nombre de usuario de administrador de la base de datos de catálogo. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 128
catalogPricingTier Plan de tarifa de la base de datos de catálogo. Los valores válidos se pueden encontrar en https://azure.microsoft.com/en-us/pricing/details/sql-database/ "Básico"
'Premium'
'PremiumRS'
'Estándar'
catalogServerEndpoint Dirección URL del servidor de base de datos del catálogo. cuerda

IntegrationRuntimeSsisProperties

Nombre Descripción Valor
catalogInfo Información del catálogo para el entorno de ejecución de integración dedicado administrado. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Propiedades del script de instalación personalizada para un entorno de ejecución de integración dedicado administrado. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Propiedades de proxy de datos para un entorno de ejecución de integración dedicado administrado. IntegrationRuntimeDataProxyProperties
edición Edición de SSIS Integration Runtime "Enterprise"
'Estándar'
expressCustomSetupProperties Configuración personalizada sin propiedades de script para un entorno de ejecución de integración de SSIS. CustomSetupBase []
licenseType Tipo de licencia para traer su propio escenario de licencia. 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Nombre Descripción Valor
publicIPs Identificadores de recursos de las direcciones IP públicas que usará este entorno de ejecución de integración. string[]
subred Nombre de la subred a la que se unirá este entorno de ejecución de integración. cuerda
subnetId El identificador de la subred, al que se unirá este Azure-SSIS integration Runtime. cuerda
vNetId Identificador de la red virtual a la que se unirá este entorno de ejecución de integración. cuerda

LicensedComponentSetupTypeProperties

Nombre Descripción Valor
componentName Nombre del componente de terceros. string (obligatorio)
licenseKey Clave de licencia para activar el componente. SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Nombre Descripción Valor
authorizationType Tipo de autorización para el uso compartido de Integration Runtime. 'Key' (obligatorio)
llave Clave que se usa para la autorización. SecureString (obligatorio)

LinkedIntegrationRuntimeRbacAuthorization

Nombre Descripción Valor
authorizationType Tipo de autorización para el uso compartido de Integration Runtime. 'RBAC' (obligatorio)
resourceId Identificador de recurso del entorno de ejecución de integración que se va a compartir. string (obligatorio)

LinkedIntegrationRuntimeType

Nombre Descripción Valor
authorizationType Establezca en "Key" para el tipo LinkedIntegrationRuntimeKeyAuthorization. Establezca en "RBAC" para el tipo LinkedIntegrationRuntimeRbacAuthorization. 'Clave'
'RBAC' (obligatorio)

ManagedIntegrationRuntime

Nombre Descripción Valor
tipo Tipo de entorno de ejecución de integración. "Administrado" (obligatorio)
typeProperties Propiedades del entorno de ejecución de integración administrada. ManagedIntegrationRuntimeTypeProperties (obligatorio)

ManagedIntegrationRuntimeTypeProperties

Nombre Descripción Valor
computeProperties Recurso de proceso para el entorno de ejecución de integración administrado. IntegrationRuntimeComputeProperties
ssisProperties Propiedades de SSIS para el entorno de ejecución de integración administrado. IntegrationRuntimeSsisProperties

Microsoft.Synapse/workspaces/integrationRuntimes

Nombre Descripción Valor
nombre El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: áreas de trabajo
Propiedades Propiedades de Integration Runtime. IntegrationRuntime (obligatorio)
tipo El tipo de recurso "Microsoft.Synapse/workspaces/integrationRuntimes@2020-12-01"

SecretBase

Nombre Descripción Valor
tipo Establezca en "SecureString" para el tipo SecureString. "SecureString" (obligatorio)

SecureString

Nombre Descripción Valor
tipo Tipo del secreto. string (obligatorio)
valor Valor de cadena segura. string (obligatorio)

SecureString

Nombre Descripción Valor
tipo Tipo del secreto. "SecureString" (obligatorio)
valor Valor de cadena segura. string (obligatorio)

SelfHostedIntegrationRuntime

Nombre Descripción Valor
tipo Tipo de entorno de ejecución de integración. 'SelfHosted' (obligatorio)
typeProperties Cuando esta propiedad no es null, significa que se trata de un entorno de ejecución de integración vinculado. La propiedad se usa para acceder al entorno de ejecución de integración original. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Nombre Descripción Valor
linkedInfo Tipo de entorno de ejecución de integración vinculado de Data Factory LinkedIntegrationRuntimeType