Áreas de trabalho do Microsoft.Synapse 2021-05-01

  • Artigo

Definição de recurso do Bicep

O tipo de recurso das áreas de trabalho pode ser implementado com operações que visam:

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

Formato do recurso

Para criar um recurso Microsoft.Synapse/áreas de trabalho, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Synapse/workspaces@2021-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    connectivityEndpoints: {}
    cspWorkspaceAdminProperties: {
      initialWorkspaceAdminObjectId: 'string'
    }
    defaultDataLakeStorage: {
      accountUrl: 'string'
      filesystem: 'string'
    }
    encryption: {
      cmk: {
        kekIdentity: {
          userAssignedIdentity: 'string'
          useSystemAssignedIdentity: any()
        }
        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 propriedade

áreas de trabalho

Nome Descrição Valor
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 1-50

Carateres válidos:
Letras minúsculas, hífenes e números.

Comece e termine com letra ou número.

Não é possível conter -ondemand

O nome do recurso tem de ser exclusivo em todo o Azure.
localização A localização geográfica onde o recurso se encontra cadeia (obrigatório)
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
identidade Identidade da área de trabalho ManagedIdentity
propriedades Propriedades do recurso da área de trabalho WorkspaceProperties

ManagedIdentity

Nome Descrição Valor
tipo O tipo de identidade gerida para a área de trabalho "Nenhum"
"SystemAssigned"
"SystemAssigned,UserAssigned"
userAssignedIdentities O utilizador atribuiu identidades geridas. objeto

WorkspaceProperties

Nome Descrição Valor
connectivityEndpoints Pontos finais de conectividade objeto
cspWorkspaceAdminProperties Propriedades iniciais do administrador do AAD para uma subscrição CSP CspWorkspaceAdminProperties
defaultDataLakeStorage Detalhes da conta de armazenamento do data lake predefinida da área de trabalho DataLakeStorageAccountDetails
Encriptação Os detalhes de encriptação da área de trabalho EncryptionDetails
managedResourceGroupName Grupo de recursos geridos da área de trabalho. O nome do grupo de recursos identifica exclusivamente o grupo de recursos no user subscriptionId. O nome do grupo de recursos não tem de ter mais de 90 carateres de comprimento e tem de ser carateres alfanuméricos (Char.IsLetterOrDigit()) e "-", "_", "(", ")" e".". Tenha em atenção que o nome não pode terminar com "". string
managedVirtualNetwork Definir esta opção como "predefinição" irá garantir que toda a computação para esta área de trabalho está numa rede virtual gerida em nome do utilizador. string
managedVirtualNetworkSettings Definições de Rede Virtual Geridas ManagedVirtualNetworkSettings
privateEndpointConnections Ligações de ponto final privado à área de trabalho PrivateEndpointConnection[]
publicNetworkAccess Ativar ou Desativar o acesso de rede pública à área de trabalho "Desativado"
"Ativado"
purviewConfiguration Configuração do Purview PurviewConfiguration
sqlAdministratorLogin Iniciar sessão para administrador do SQL Active Directory da área de trabalho string
sqlAdministratorLoginPassword Palavra-passe de início de sessão do administrador do SQL string
virtualNetworkProfile perfil de Rede Virtual VirtualNetworkProfile
workspaceRepositoryConfiguration Definições de integração do Git WorkspaceRepositoryConfiguration

CspWorkspaceAdminProperties

Nome Descrição Valor
initialWorkspaceAdminObjectId ID de objeto do AAD do administrador da área de trabalho inicial string

DataLakeStorageAccountDetails

Nome Descrição Valor
accountUrl URL da Conta string
sistema de ficheiros Nome do sistema de ficheiros string

EncryptionDetails

Nome Descrição Valor
cmk Detalhes da Chave Gerida pelo Cliente CustomerManagedKeyDetails

CustomerManagedKeyDetails

Nome Descrição Valor
kekIdentity Chave de encriptação de chaves KekIdentityProperties
key O objeto chave da área de trabalho WorkspaceKeyDetails

KekIdentityProperties

Nome Descrição Valor
userAssignedIdentity ID do recurso de identidade atribuído pelo utilizador string
useSystemAssignedIdentity Valor booleano que especifica se deve ou não utilizar a identidade atribuída pelo sistema Para Bicep, pode utilizar a função any( ).

WorkspaceKeyDetails

Nome Descrição Valor
keyVaultUrl URL do cofre de chaves de sub-recurso da Chave de Área de Trabalho string
name Nome do sub-recurso da Chave de Área de Trabalho string

ManagedVirtualNetworkSettings

Nome Descrição Valor
allowedAadTenantIdsForLinking IDs de Inquilino do Aad Permitidos para Ligação string[]
linkedAccessCheckOnTargetResource Verificação de Acesso Ligado no Recurso de Destino bool
preventDataExfiltration Impedir a Transferência de Dados Não Autorizada bool

PrivateEndpointConnection

Nome Descrição Valor
propriedades Propriedades de ligação de ponto final privado. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nome Descrição Valor
privateEndpoint O ponto final privado ao qual pertence a ligação. PrivateEndpoint
privateLinkServiceConnectionState Estado de ligação da ligação do ponto final privado. PrivateLinkServiceConnectionState

PrivateEndpoint

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

PrivateLinkServiceConnectionState

Nome Descrição Valor
descrição A descrição da ligação do serviço de ligação privada. string
status O estado da ligação do serviço de ligação privada. string

PurviewConfiguration

Nome Descrição Valor
purviewResourceId ID de Recurso do Purview string

VirtualNetworkProfile

Nome Descrição Valor
computeSubnetId ID da sub-rede utilizado para cálculos na área de trabalho string

WorkspaceRepositoryConfiguration

Nome Descrição Valor
accountName Nome da conta string
collaborationBranch Ramo de colaboração string
hostName Nome do anfitrião do GitHub Enterprise. Por exemplo: https://github.mydomain.com string
lastCommitId O último ID de consolidação string
projectName Nome do projeto VSTS string
repositoryName Nome do repositório string
rootFolder Pasta raiz a utilizar no repositório string
tenantId O ID de inquilino do VSTS string
tipo Tipo de configuração do repositórioID da área de trabalho. Exemplo workspaceVSTSConfiguration, WorkspaceGitHubConfiguration string

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Azure Synapse Prova de Conceito

Implementar no Azure		 Este modelo cria um ambiente de prova de conceito para Azure Synapse, incluindo Conjuntos de SQL e Conjuntos do Apache Spark opcionais

Definição de recurso do modelo arm

O tipo de recurso das áreas de trabalho pode ser implementado com operações que visam:

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

Formato do recurso

Para criar um recurso Microsoft.Synapse/workspaces, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Synapse/workspaces",
  "apiVersion": "2021-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "connectivityEndpoints": {},
    "cspWorkspaceAdminProperties": {
      "initialWorkspaceAdminObjectId": "string"
    },
    "defaultDataLakeStorage": {
      "accountUrl": "string",
      "filesystem": "string"
    },
    "encryption": {
      "cmk": {
        "kekIdentity": {
          "userAssignedIdentity": "string",
          "useSystemAssignedIdentity": {}
        },
        "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 propriedade

áreas de trabalho

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Synapse/workspaces"
apiVersion A versão da API de recursos '2021-05-01'
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 1-50

Carateres válidos:
Letras minúsculas, hífenes e números.

Comece e termine com letra ou número.

Não é possível conter -ondemand

O nome do recurso tem de ser exclusivo em todo o Azure.
localização A localização geográfica onde reside o recurso cadeia (obrigatório)
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
identidade Identidade da área de trabalho ManagedIdentity
propriedades Propriedades do recurso da área de trabalho WorkspaceProperties

ManagedIdentity

Nome Descrição Valor
tipo O tipo de identidade gerida para a área de trabalho "Nenhum"
"SystemAssigned"
"SystemAssigned,UserAssigned"
userAssignedIdentities As identidades geridas atribuídas pelo utilizador. objeto

WorkspaceProperties

Nome Descrição Valor
connectivityEndpoints Pontos finais de conectividade objeto
cspWorkspaceAdminProperties Propriedades iniciais do administrador do AAD para uma subscrição CSP CspWorkspaceAdminProperties
defaultDataLakeStorage Detalhes da conta do Data Lake Storage predefinida da área de trabalho DataLakeStorageAccountDetails
Encriptação Os detalhes de encriptação da área de trabalho EncryptionDetails
managedResourceGroupName Grupo de recursos geridos da área de trabalho. O nome do grupo de recursos identifica exclusivamente o grupo de recursos no subscriptionId do utilizador. O nome do grupo de recursos não deve ter mais de 90 carateres de comprimento e tem de ter carateres alfanuméricos (Char.IsLetterOrDigit()) e "-", "_", "(", ")" e".". Tenha em atenção que o nome não pode terminar com '.' string
managedVirtualNetwork Definir esta opção como "predefinição" irá garantir que toda a computação desta área de trabalho está numa rede virtual gerida em nome do utilizador. string
managedVirtualNetworkSettings Definições de Rede Virtual Geridas ManagedVirtualNetworkSettings
privateEndpointConnections Ligações de ponto final privado à área de trabalho PrivateEndpointConnection[]
publicNetworkAccess Ativar ou Desativar o acesso de rede pública à área de trabalho "Desativado"
"Ativado"
purviewConfiguration Configuração do Purview PurviewConfiguration
sqlAdministratorLogin Iniciar sessão para o administrador do SQL Active Directory da área de trabalho string
sqlAdministratorLoginPassword Palavra-passe de início de sessão do administrador do SQL string
virtualNetworkProfile perfil de Rede Virtual VirtualNetworkProfile
workspaceRepositoryConfiguration Definições de integração do Git WorkspaceRepositoryConfiguration

CspWorkspaceAdminProperties

Nome Descrição Valor
initialWorkspaceAdminObjectId ID de objeto do AAD do administrador da área de trabalho inicial string

DataLakeStorageAccountDetails

Nome Descrição Valor
accountUrl URL da Conta string
sistema de ficheiros Nome do sistema de ficheiros string

EncryptionDetails

Nome Descrição Valor
cmk Detalhes da Chave Gerida pelo Cliente CustomerManagedKeyDetails

CustomerManagedKeyDetails

Nome Descrição Valor
kekIdentity Chave de encriptação de chaves KekIdentityProperties
key O objeto chave da área de trabalho WorkspaceKeyDetails

KekIdentityProperties

Nome Descrição Valor
userAssignedIdentity ID do recurso de identidade atribuído pelo utilizador string
useSystemAssignedIdentity Booleano a especificar se deve ou não utilizar a identidade atribuída pelo sistema

WorkspaceKeyDetails

Nome Descrição Valor
keyVaultUrl URL do cofre de chaves de sub-recursos da Chave de Área de Trabalho string
name Nome do sub-recurso chave da área de trabalho string

ManagedVirtualNetworkSettings

Nome Descrição Valor
allowedAadTenantIdsForLinking IDs de Inquilino do Aad Permitidos para Ligação cadeia[]
linkedAccessCheckOnTargetResource Verificação de Acesso Ligado no Recurso de Destino bool
preventDataExfiltration Impedir a Exfiltração de Dados bool

PrivateEndpointConnection

Nome Descrição Valor
propriedades Propriedades de ligação de ponto final privado. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nome Descrição Valor
privateEndpoint O ponto final privado ao qual a ligação pertence. PrivateEndpoint
privateLinkServiceConnectionState Estado de ligação da ligação de ponto final privado. PrivateLinkServiceConnectionState

PrivateEndpoint

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

PrivateLinkServiceConnectionState

Nome Descrição Valor
descrição A descrição da ligação do serviço de ligação privada. string
status O estado da ligação do serviço de ligação privada. string

PurviewConfiguration

Nome Descrição Valor
purviewResourceId ID de Recurso do Purview string

VirtualNetworkProfile

Nome Descrição Valor
computeSubnetId ID da sub-rede utilizado para cálculos na área de trabalho string

WorkspaceRepositoryConfiguration

Nome Descrição Valor
accountName Nome da conta string
collaborationBranch Ramo de colaboração string
hostName Nome do anfitrião do GitHub Enterprise. Por exemplo: https://github.mydomain.com string
lastCommitId O último ID de consolidação string
projectName Nome do projeto VSTS string
repositórioName Nome do repositório string
rootFolder Pasta raiz a utilizar no repositório string
tenantId O ID do inquilino do VSTS string
tipo Tipo de configuração do repositórioID da área de trabalho. Exemplo workspaceVSTSConfiguration, WorkspaceGitHubConfiguration string

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Azure Synapse Prova de Conceito

Implementar no Azure		 Este modelo cria um ambiente de prova de conceito para Azure Synapse, incluindo Conjuntos de SQL e Conjuntos do Apache Spark opcionais

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso das áreas de trabalho pode ser implementado com operações que visam:

  • Grupos de recursos

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

Formato do recurso

Para criar um recurso Microsoft.Synapse/workspaces, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces@2021-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      connectivityEndpoints = {}
      cspWorkspaceAdminProperties = {
        initialWorkspaceAdminObjectId = "string"
      }
      defaultDataLakeStorage = {
        accountUrl = "string"
        filesystem = "string"
      }
      encryption = {
        cmk = {
          kekIdentity = {
            userAssignedIdentity = "string"
          }
          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 propriedade

áreas de trabalho

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Synapse/workspaces@2021-05-01"
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 1-50

Carateres válidos:
Letras minúsculas, hífenes e números.

Comece e termine com letra ou número.

Não é possível conter -ondemand

O nome do recurso tem de ser exclusivo em todo o Azure.
localização A localização geográfica onde reside o recurso cadeia (obrigatório)
parent_id Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. cadeia (obrigatório)
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas.
identidade Identidade da área de trabalho ManagedIdentity
propriedades Propriedades do recurso da área de trabalho WorkspaceProperties

ManagedIdentity

Nome Descrição Valor
tipo O tipo de identidade gerida para a área de trabalho "SystemAssigned"
"SystemAssigned,UserAssigned"
identity_ids As identidades geridas atribuídas pelo utilizador. Matriz de IDs de identidade do utilizador.

WorkspaceProperties

Nome Descrição Valor
connectivityEndpoints Pontos finais de conectividade objeto
cspWorkspaceAdminProperties Propriedades iniciais do administrador do AAD para uma subscrição CSP CspWorkspaceAdminProperties
defaultDataLakeStorage Detalhes da conta do Data Lake Storage predefinida da área de trabalho DataLakeStorageAccountDetails
Encriptação Os detalhes de encriptação da área de trabalho EncryptionDetails
managedResourceGroupName Grupo de recursos geridos da área de trabalho. O nome do grupo de recursos identifica exclusivamente o grupo de recursos no subscriptionId do utilizador. O nome do grupo de recursos não deve ter mais de 90 carateres de comprimento e tem de ter carateres alfanuméricos (Char.IsLetterOrDigit()) e "-", "_", "(", ")" e".". Tenha em atenção que o nome não pode terminar com '.' string
managedVirtualNetwork Definir esta opção como "predefinição" irá garantir que toda a computação desta área de trabalho está numa rede virtual gerida em nome do utilizador. string
managedVirtualNetworkSettings Definições de Rede Virtual Geridas ManagedVirtualNetworkSettings
privateEndpointConnections Ligações de ponto final privado à área de trabalho PrivateEndpointConnection[]
publicNetworkAccess Ativar ou Desativar o acesso de rede pública à área de trabalho "Desativado"
"Ativado"
purviewConfiguration Configuração do Purview PurviewConfiguration
sqlAdministratorLogin Iniciar sessão para o administrador do SQL Active Directory da área de trabalho string
sqlAdministratorLoginPassword Palavra-passe de início de sessão do administrador do SQL string
virtualNetworkProfile perfil de Rede Virtual VirtualNetworkProfile
workspaceRepositoryConfiguration Definições de integração do Git WorkspaceRepositoryConfiguration

CspWorkspaceAdminProperties

Nome Descrição Valor
initialWorkspaceAdminObjectId ID de objeto do AAD do administrador da área de trabalho inicial string

DataLakeStorageAccountDetails

Nome Descrição Valor
accountUrl URL da Conta string
sistema de ficheiros Nome do sistema de ficheiros string

EncryptionDetails

Nome Descrição Valor
cmk Detalhes da Chave Gerida pelo Cliente CustomerManagedKeyDetails

CustomerManagedKeyDetails

Nome Descrição Valor
kekIdentity Chave de encriptação de chaves KekIdentityProperties
key O objeto chave da área de trabalho WorkspaceKeyDetails

KekIdentityProperties

Nome Descrição Valor
userAssignedIdentity ID do recurso de identidade atribuído pelo utilizador string
useSystemAssignedIdentity Booleano a especificar se deve ou não utilizar a identidade atribuída pelo sistema

WorkspaceKeyDetails

Nome Descrição Valor
keyVaultUrl URL do cofre de chaves de sub-recursos da Chave de Área de Trabalho string
name Nome do sub-recurso chave da área de trabalho string

ManagedVirtualNetworkSettings

Nome Descrição Valor
allowedAadTenantIdsForLinking IDs de Inquilino do Aad Permitidos para Ligação cadeia[]
linkedAccessCheckOnTargetResource Verificação de Acesso Ligado no Recurso de Destino bool
preventDataExfiltration Impedir a Exfiltração de Dados bool

PrivateEndpointConnection

Nome Descrição Valor
propriedades Propriedades de ligação de ponto final privado. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nome Descrição Valor
privateEndpoint O ponto final privado ao qual a ligação pertence. PrivateEndpoint
privateLinkServiceConnectionState Estado de ligação da ligação de ponto final privado. PrivateLinkServiceConnectionState

PrivateEndpoint

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

PrivateLinkServiceConnectionState

Nome Descrição Valor
descrição A descrição da ligação do serviço de ligação privada. string
status O estado da ligação do serviço de ligação privada. string

PurviewConfiguration

Nome Descrição Valor
purviewResourceId ID de Recurso do Purview string

VirtualNetworkProfile

Nome Descrição Valor
computeSubnetId ID da sub-rede utilizado para cálculos na área de trabalho string

WorkspaceRepositoryConfiguration

Nome Descrição Valor
accountName Nome da conta string
collaborationBranch Ramo de colaboração string
hostName Nome do anfitrião do GitHub Enterprise. Por exemplo: https://github.mydomain.com string
lastCommitId O último ID de consolidação string
projectName Nome do projeto VSTS string
repositórioName Nome do repositório string
rootFolder Pasta raiz a utilizar no repositório string
tenantId O ID do inquilino do VSTS string
tipo Tipo de configuração do repositórioID da área de trabalho. Exemplo workspaceVSTSConfiguration, WorkspaceGitHubConfiguration string