Compartir a través de

Áreas de trabajo de Microsoft.Synapse 2021-04-01-preview

Definición de recursos de Bicep

El tipo de recurso workspaces 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, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.Synapse/workspaces@2021-04-01-preview' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    connectivityEndpoints: {
      {customized property}: 'string'
    }
    defaultDataLakeStorage: {
      accountUrl: 'string'
      filesystem: 'string'
    }
    encryption: {
      cmk: {
        key: {
          keyVaultUrl: 'string'
          name: 'string'
        }
      }
    }
    managedResourceGroupName: 'string'
    managedVirtualNetwork: 'string'
    managedVirtualNetworkSettings: {
      allowedAadTenantIdsForLinking: [
        'string'
      ]
      linkedAccessCheckOnTargetResource: bool
      preventDataExfiltration: bool
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    purviewConfiguration: {
      purviewResourceId: 'string'
    }
    sqlAdministratorLogin: 'string'
    sqlAdministratorLoginPassword: 'string'
    virtualNetworkProfile: {
      computeSubnetId: 'string'
    }
    workspaceRepositoryConfiguration: {
      accountName: 'string'
      collaborationBranch: 'string'
      hostName: 'string'
      lastCommitId: 'string'
      projectName: 'string'
      repositoryName: 'string'
      rootFolder: 'string'
      tenantId: 'string'
      type: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

Microsoft.Synapse/workspaces

Nombre Descripción Valor
identidad Identidad del área de trabajo managedIdentity
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades de recursos del área de trabajo WorkspaceProperties (Propiedades del espacio de trabajo)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

CustomerManagedKeyDetails

Nombre Descripción Valor
llave El objeto clave del área de trabajo WorkspaceKeyDetails

DataLakeStorageAccountDetails

Nombre Descripción Valor
accountUrl Dirección URL de la cuenta cuerda
sistema de archivos Nombre del sistema de archivos cuerda

EncryptionDetails

Nombre Descripción Valor
CMK Detalles de clave administrada por el cliente customerManagedKeyDetails

Identidad administrada

Nombre Descripción Valor
tipo Tipo de identidad administrada para el área de trabajo 'Ninguno'
'SystemAssigned'

ManagedVirtualNetworkSettings

Nombre Descripción Valor
allowedAadTenantIdsForLinking Identificadores de inquilino de Aad permitidos para vincular cadena[]
linkedAccessCheckOnTargetResource Comprobación de acceso vinculado en el recurso de destino Bool
preventDataExfiltration Impedir la filtración de datos Bool

Punto de conexión privado

Nombre Descripción Valor

PrivateEndpointConnection

Nombre Descripción Valor
Propiedades Propiedades de conexión de punto de conexión privado. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nombre Descripción Valor
privateEndpoint Punto de conexión privado al que pertenece la conexión. PrivateEndpoint
privateLinkServiceConnectionState Estado de conexión de la conexión del punto de conexión privado. PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Nombre Descripción Valor
descripción Descripción de la conexión del servicio private link. cuerda
estado Estado de conexión del servicio private link. cuerda

PurviewConfiguration

Nombre Descripción Valor
purviewResourceId Identificador de recurso de Purview cuerda

TrackedResourceTags

Nombre Descripción Valor

VirtualNetworkProfile

Nombre Descripción Valor
computeSubnetId Identificador de subred usado para los procesos en el área de trabajo cuerda

WorkspaceKeyDetails

Nombre Descripción Valor
keyVaultUrl Dirección URL del almacén de claves de subrecurso de la clave del área de trabajo cuerda
nombre Nombre del subrecurso de clave del área de trabajo cuerda

WorkspaceProperties (Propiedades del espacio de trabajo)

Nombre Descripción Valor
connectivityEndpoints Puntos de conexión de conectividad WorkspacePropertiesConnectivityEndpoints
defaultDataLakeStorage Detalles de la cuenta de almacenamiento de Data Lake predeterminada del área de trabajo DataLakeStorageAccountDetails
encriptación Detalles de cifrado del área de trabajo EncryptionDetails
managedResourceGroupName Grupo de recursos administrados del área de trabajo. El nombre del grupo de recursos identifica de forma única el grupo de recursos dentro del identificador de suscripción de usuario. El nombre del grupo de recursos no debe tener más de 90 caracteres y debe tener caracteres alfanuméricos (Char.IsLetterOrDigit()) y '-', '_', '(', ')' y'.'. Tenga en cuenta que el nombre no puede terminar con '.' cuerda
managedVirtualNetwork Si se establece en "valor predeterminado", se asegurará de que todo el proceso de esta área de trabajo esté en una red virtual administrada en nombre del usuario. cuerda
managedVirtualNetworkSettings Configuración de red virtual administrada ManagedVirtualNetworkSettings
privateEndpointConnections Conexiones de punto de conexión privado al área de trabajo privateEndpointConnection[]
publicNetworkAccess Habilitación o deshabilitación del acceso de red pública al área de trabajo 'Deshabilitado'
'Habilitado'
purviewConfiguration Configuración de Purview PurviewConfiguration
sqlAdministratorLogin Inicio de sesión del administrador de SQL Active Directory del área de trabajo cuerda
sqlAdministratorLoginPassword Contraseña de inicio de sesión del administrador de SQL cuerda
virtualNetworkProfile Perfil de red virtual VirtualNetworkProfile
workspaceRepositoryConfiguration Configuración de integración de Git WorkspaceRepositoryConfiguration

WorkspacePropertiesConnectivityEndpoints

Nombre Descripción Valor

WorkspaceRepositoryConfiguration

Nombre Descripción Valor
nombre de cuenta Nombre de cuenta cuerda
collaborationBranch Rama de colaboración cuerda
nombreDelHost Nombre de host de GitHub Enterprise. Por ejemplo: https://github.mydomain.com cuerda
lastCommitId El último identificador de confirmación cuerda
Nombre del proyecto Nombre del proyecto de VSTS cuerda
nombreDelRepositorio Nombre del repositorio cuerda
Carpeta raíz Carpeta raíz que se va a usar en el repositorio cuerda
ID del arrendatario Identificador de inquilino de VSTS cuerda

Restricciones:
Longitud mínima = 36
Longitud máxima = 36
Patrón = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tipo Tipo de configuración de repositoryID del área de trabajo. Ejemplo workspaceVSTSConfiguration, WorkspaceGitHubConfiguration cuerda

Ejemplos de uso

Módulos comprobados de Azure

Los siguientes módulos comprobados de Azure se pueden usar para implementar este tipo de recurso.

Módulo Descripción
Área de trabajo de Azure Synapse Analytics Módulo de recursos de AVM para el área de trabajo de Azure Synapse Analytics

Definición de recursos de plantilla de ARM

El tipo de recurso workspaces 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, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.Synapse/workspaces",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "connectivityEndpoints": {
      "{customized property}": "string"
    },
    "defaultDataLakeStorage": {
      "accountUrl": "string",
      "filesystem": "string"
    },
    "encryption": {
      "cmk": {
        "key": {
          "keyVaultUrl": "string",
          "name": "string"
        }
      }
    },
    "managedResourceGroupName": "string",
    "managedVirtualNetwork": "string",
    "managedVirtualNetworkSettings": {
      "allowedAadTenantIdsForLinking": [ "string" ],
      "linkedAccessCheckOnTargetResource": "bool",
      "preventDataExfiltration": "bool"
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "purviewConfiguration": {
      "purviewResourceId": "string"
    },
    "sqlAdministratorLogin": "string",
    "sqlAdministratorLoginPassword": "string",
    "virtualNetworkProfile": {
      "computeSubnetId": "string"
    },
    "workspaceRepositoryConfiguration": {
      "accountName": "string",
      "collaborationBranch": "string",
      "hostName": "string",
      "lastCommitId": "string",
      "projectName": "string",
      "repositoryName": "string",
      "rootFolder": "string",
      "tenantId": "string",
      "type": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

Microsoft.Synapse/workspaces

Nombre Descripción Valor
apiVersion La versión de api '2021-04-01-preestreno'
identidad Identidad del área de trabajo managedIdentity
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades de recursos del área de trabajo WorkspaceProperties (Propiedades del espacio de trabajo)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo El tipo de recurso "Microsoft.Synapse/workspaces"

CustomerManagedKeyDetails

Nombre Descripción Valor
llave El objeto clave del área de trabajo WorkspaceKeyDetails

DataLakeStorageAccountDetails

Nombre Descripción Valor
accountUrl Dirección URL de la cuenta cuerda
sistema de archivos Nombre del sistema de archivos cuerda

EncryptionDetails

Nombre Descripción Valor
CMK Detalles de clave administrada por el cliente customerManagedKeyDetails

Identidad administrada

Nombre Descripción Valor
tipo Tipo de identidad administrada para el área de trabajo 'Ninguno'
'SystemAssigned'

ManagedVirtualNetworkSettings

Nombre Descripción Valor
allowedAadTenantIdsForLinking Identificadores de inquilino de Aad permitidos para vincular cadena[]
linkedAccessCheckOnTargetResource Comprobación de acceso vinculado en el recurso de destino Bool
preventDataExfiltration Impedir la filtración de datos Bool

Punto de conexión privado

Nombre Descripción Valor

PrivateEndpointConnection

Nombre Descripción Valor
Propiedades Propiedades de conexión de punto de conexión privado. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nombre Descripción Valor
privateEndpoint Punto de conexión privado al que pertenece la conexión. PrivateEndpoint
privateLinkServiceConnectionState Estado de conexión de la conexión del punto de conexión privado. PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Nombre Descripción Valor
descripción Descripción de la conexión del servicio private link. cuerda
estado Estado de conexión del servicio private link. cuerda

PurviewConfiguration

Nombre Descripción Valor
purviewResourceId Identificador de recurso de Purview cuerda

TrackedResourceTags

Nombre Descripción Valor

VirtualNetworkProfile

Nombre Descripción Valor
computeSubnetId Identificador de subred usado para los procesos en el área de trabajo cuerda

WorkspaceKeyDetails

Nombre Descripción Valor
keyVaultUrl Dirección URL del almacén de claves de subrecurso de la clave del área de trabajo cuerda
nombre Nombre del subrecurso de clave del área de trabajo cuerda

WorkspaceProperties (Propiedades del espacio de trabajo)

Nombre Descripción Valor
connectivityEndpoints Puntos de conexión de conectividad WorkspacePropertiesConnectivityEndpoints
defaultDataLakeStorage Detalles de la cuenta de almacenamiento de Data Lake predeterminada del área de trabajo DataLakeStorageAccountDetails
encriptación Detalles de cifrado del área de trabajo EncryptionDetails
managedResourceGroupName Grupo de recursos administrados del área de trabajo. El nombre del grupo de recursos identifica de forma única el grupo de recursos dentro del identificador de suscripción de usuario. El nombre del grupo de recursos no debe tener más de 90 caracteres y debe tener caracteres alfanuméricos (Char.IsLetterOrDigit()) y '-', '_', '(', ')' y'.'. Tenga en cuenta que el nombre no puede terminar con '.' cuerda
managedVirtualNetwork Si se establece en "valor predeterminado", se asegurará de que todo el proceso de esta área de trabajo esté en una red virtual administrada en nombre del usuario. cuerda
managedVirtualNetworkSettings Configuración de red virtual administrada ManagedVirtualNetworkSettings
privateEndpointConnections Conexiones de punto de conexión privado al área de trabajo privateEndpointConnection[]
publicNetworkAccess Habilitación o deshabilitación del acceso de red pública al área de trabajo 'Deshabilitado'
'Habilitado'
purviewConfiguration Configuración de Purview PurviewConfiguration
sqlAdministratorLogin Inicio de sesión del administrador de SQL Active Directory del área de trabajo cuerda
sqlAdministratorLoginPassword Contraseña de inicio de sesión del administrador de SQL cuerda
virtualNetworkProfile Perfil de red virtual VirtualNetworkProfile
workspaceRepositoryConfiguration Configuración de integración de Git WorkspaceRepositoryConfiguration

WorkspacePropertiesConnectivityEndpoints

Nombre Descripción Valor

WorkspaceRepositoryConfiguration

Nombre Descripción Valor
nombre de cuenta Nombre de cuenta cuerda
collaborationBranch Rama de colaboración cuerda
nombreDelHost Nombre de host de GitHub Enterprise. Por ejemplo: https://github.mydomain.com cuerda
lastCommitId El último identificador de confirmación cuerda
Nombre del proyecto Nombre del proyecto de VSTS cuerda
nombreDelRepositorio Nombre del repositorio cuerda
Carpeta raíz Carpeta raíz que se va a usar en el repositorio cuerda
ID del arrendatario Identificador de inquilino de VSTS cuerda

Restricciones:
Longitud mínima = 36
Longitud máxima = 36
Patrón = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tipo Tipo de configuración de repositoryID del área de trabajo. Ejemplo workspaceVSTSConfiguration, WorkspaceGitHubConfiguration cuerda

Ejemplos de uso

Plantillas de inicio rápido de Azure

Los siguientes plantillas de inicio rápido de Azure implementar este tipo de recurso.

Plantilla Descripción
de prueba de concepto de Azure Synapse

Implementación en Azure 		Esta plantilla crea un entorno de prueba de concepto para Azure Synapse, incluidos los grupos de SQL y los grupos de Apache Spark opcionales.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso workspaces 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, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces@2021-04-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      connectivityEndpoints = {
        {customized property} = "string"
      }
      defaultDataLakeStorage = {
        accountUrl = "string"
        filesystem = "string"
      }
      encryption = {
        cmk = {
          key = {
            keyVaultUrl = "string"
            name = "string"
          }
        }
      }
      managedResourceGroupName = "string"
      managedVirtualNetwork = "string"
      managedVirtualNetworkSettings = {
        allowedAadTenantIdsForLinking = [
          "string"
        ]
        linkedAccessCheckOnTargetResource = bool
        preventDataExfiltration = bool
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      purviewConfiguration = {
        purviewResourceId = "string"
      }
      sqlAdministratorLogin = "string"
      sqlAdministratorLoginPassword = "string"
      virtualNetworkProfile = {
        computeSubnetId = "string"
      }
      workspaceRepositoryConfiguration = {
        accountName = "string"
        collaborationBranch = "string"
        hostName = "string"
        lastCommitId = "string"
        projectName = "string"
        repositoryName = "string"
        rootFolder = "string"
        tenantId = "string"
        type = "string"
      }
    }
  }
}

Valores de propiedad

Microsoft.Synapse/workspaces

Nombre Descripción Valor
identidad Identidad del área de trabajo managedIdentity
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades de recursos del área de trabajo WorkspaceProperties (Propiedades del espacio de trabajo)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta.
tipo El tipo de recurso "Microsoft.Synapse/workspaces@2021-04-01-preview"

CustomerManagedKeyDetails

Nombre Descripción Valor
llave El objeto clave del área de trabajo WorkspaceKeyDetails

DataLakeStorageAccountDetails

Nombre Descripción Valor
accountUrl Dirección URL de la cuenta cuerda
sistema de archivos Nombre del sistema de archivos cuerda

EncryptionDetails

Nombre Descripción Valor
CMK Detalles de clave administrada por el cliente customerManagedKeyDetails

Identidad administrada

Nombre Descripción Valor
tipo Tipo de identidad administrada para el área de trabajo 'Ninguno'
'SystemAssigned'

ManagedVirtualNetworkSettings

Nombre Descripción Valor
allowedAadTenantIdsForLinking Identificadores de inquilino de Aad permitidos para vincular cadena[]
linkedAccessCheckOnTargetResource Comprobación de acceso vinculado en el recurso de destino Bool
preventDataExfiltration Impedir la filtración de datos Bool

Punto de conexión privado

Nombre Descripción Valor

PrivateEndpointConnection

Nombre Descripción Valor
Propiedades Propiedades de conexión de punto de conexión privado. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nombre Descripción Valor
privateEndpoint Punto de conexión privado al que pertenece la conexión. PrivateEndpoint
privateLinkServiceConnectionState Estado de conexión de la conexión del punto de conexión privado. PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Nombre Descripción Valor
descripción Descripción de la conexión del servicio private link. cuerda
estado Estado de conexión del servicio private link. cuerda

PurviewConfiguration

Nombre Descripción Valor
purviewResourceId Identificador de recurso de Purview cuerda

TrackedResourceTags

Nombre Descripción Valor

VirtualNetworkProfile

Nombre Descripción Valor
computeSubnetId Identificador de subred usado para los procesos en el área de trabajo cuerda

WorkspaceKeyDetails

Nombre Descripción Valor
keyVaultUrl Dirección URL del almacén de claves de subrecurso de la clave del área de trabajo cuerda
nombre Nombre del subrecurso de clave del área de trabajo cuerda

WorkspaceProperties (Propiedades del espacio de trabajo)

Nombre Descripción Valor
connectivityEndpoints Puntos de conexión de conectividad WorkspacePropertiesConnectivityEndpoints
defaultDataLakeStorage Detalles de la cuenta de almacenamiento de Data Lake predeterminada del área de trabajo DataLakeStorageAccountDetails
encriptación Detalles de cifrado del área de trabajo EncryptionDetails
managedResourceGroupName Grupo de recursos administrados del área de trabajo. El nombre del grupo de recursos identifica de forma única el grupo de recursos dentro del identificador de suscripción de usuario. El nombre del grupo de recursos no debe tener más de 90 caracteres y debe tener caracteres alfanuméricos (Char.IsLetterOrDigit()) y '-', '_', '(', ')' y'.'. Tenga en cuenta que el nombre no puede terminar con '.' cuerda
managedVirtualNetwork Si se establece en "valor predeterminado", se asegurará de que todo el proceso de esta área de trabajo esté en una red virtual administrada en nombre del usuario. cuerda
managedVirtualNetworkSettings Configuración de red virtual administrada ManagedVirtualNetworkSettings
privateEndpointConnections Conexiones de punto de conexión privado al área de trabajo privateEndpointConnection[]
publicNetworkAccess Habilitación o deshabilitación del acceso de red pública al área de trabajo 'Deshabilitado'
'Habilitado'
purviewConfiguration Configuración de Purview PurviewConfiguration
sqlAdministratorLogin Inicio de sesión del administrador de SQL Active Directory del área de trabajo cuerda
sqlAdministratorLoginPassword Contraseña de inicio de sesión del administrador de SQL cuerda
virtualNetworkProfile Perfil de red virtual VirtualNetworkProfile
workspaceRepositoryConfiguration Configuración de integración de Git WorkspaceRepositoryConfiguration

WorkspacePropertiesConnectivityEndpoints

Nombre Descripción Valor

WorkspaceRepositoryConfiguration

Nombre Descripción Valor
nombre de cuenta Nombre de cuenta cuerda
collaborationBranch Rama de colaboración cuerda
nombreDelHost Nombre de host de GitHub Enterprise. Por ejemplo: https://github.mydomain.com cuerda
lastCommitId El último identificador de confirmación cuerda
Nombre del proyecto Nombre del proyecto de VSTS cuerda
nombreDelRepositorio Nombre del repositorio cuerda
Carpeta raíz Carpeta raíz que se va a usar en el repositorio cuerda
ID del arrendatario Identificador de inquilino de VSTS cuerda

Restricciones:
Longitud mínima = 36
Longitud máxima = 36
Patrón = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tipo Tipo de configuración de repositoryID del área de trabajo. Ejemplo workspaceVSTSConfiguration, WorkspaceGitHubConfiguration cuerda