Workspaces do Microsoft.Synapse 2021-03-01

Artigo
12/20/2024

Definição de recurso do Bicep

O tipo de recurso de workspaces pode ser implantado com operações direcionadas:

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

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

Formato de recurso

Para criar um recurso Microsoft.Synapse/workspaces, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.Synapse/workspaces@2021-03-01' = {
  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 propriedade

CustomerManagedKeyDetails

Nome	Descrição	Valor
chave	O objeto chave do workspace	WorkspaceKeyDetails

DataLakeStorageAccountDetails

Nome	Descrição	Valor
accountUrl	URL da conta	corda
sistema de arquivos	Nome do sistema de arquivos	corda

EncryptionDetails

Nome	Descrição	Valor
cmk	Detalhes da chave gerenciada pelo cliente	CustomerManagedKeyDetails

ManagedIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade gerenciada para o workspace	'None' 'SystemAssigned'

ManagedVirtualNetworkSettings

Nome	Descrição	Valor
allowedAadTenantIdsForLinking	IDs de locatário do Aad permitidas para vinculação	string[]
linkedAccessCheckOnTargetResource	Verificação de acesso vinculado no recurso de destino	Bool
preventDataExfiltration	Impedir exfiltração de dados	Bool

Microsoft.Synapse/workspaces

Nome	Descrição	Valor
identidade	Identidade do workspace	ManagedIdentity
localização	A localização geográfica onde o recurso reside	cadeia de caracteres (obrigatório)
nome	O nome do recurso	cadeia de caracteres (obrigatório)
Propriedades	Propriedades do recurso do workspace	WorkspaceProperties
Tags	Marcas de recurso	Dicionário de nomes e valores de marca. Consulte Marcas em modelos

PrivateEndpoint

Nome	Descrição	Valor

PrivateEndpointConnection

Nome	Descrição	Valor
Propriedades	Propriedades de conexão de ponto de extremidade privado.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

Nome	Descrição	Valor
descrição	A descrição da conexão do serviço de link privado.	corda
estado	O status da conexão do serviço de link privado.	corda

PurviewConfiguration

Nome	Descrição	Valor
purviewResourceId	ID do recurso do Purview	corda

TrackedResourceTags

Nome	Descrição	Valor

VirtualNetworkProfile

Nome	Descrição	Valor
computeSubnetId	ID de sub-rede usada para computação no workspace	corda

WorkspaceKeyDetails

Nome	Descrição	Valor
keyVaultUrl	URL do cofre de chaves de sub-recurso da Chave do Workspace	corda
nome	Nome do subprocurso da chave do workspace	corda

WorkspaceProperties

Nome	Descrição	Valor
connectivityEndpoints	Pontos de extremidade de conectividade	WorkspacePropertiesConnectivityEndpoints
defaultDataLakeStorage	Detalhes da conta de armazenamento do data lake padrão do workspace	DataLakeStorageAccountDetails
encriptação	Os detalhes de criptografia do workspace	EncryptionDetails
managedResourceGroupName	Grupo de recursos gerenciados do workspace. O nome do grupo de recursos identifica exclusivamente o grupo de recursos dentro da subscriptionId do usuário. O nome do grupo de recursos não deve ter mais de 90 caracteres e deve ter caracteres alfanuméricos (Char.IsLetterOrDigit()) e '-', '_', '(', ')' e'. Observe que o nome não pode terminar com '.'	corda
managedVirtualNetwork	Definir isso como "padrão" garantirá que toda a computação para esse workspace esteja em uma rede virtual gerenciada em nome do usuário.	corda
managedVirtualNetworkSettings	Configurações de rede virtual gerenciada	ManagedVirtualNetworkSettings
privateEndpointConnections	Conexões de ponto de extremidade privado com o workspace	PrivateEndpointConnection []
publicNetworkAccess	Habilitar ou desabilitar o acesso à rede pública ao workspace	'Desabilitado' 'Habilitado'
purviewConfiguration	Configuração do Purview	PurviewConfiguration
sqlAdministratorLogin	Logon do administrador do active directory do SQL do workspace	corda
sqlAdministratorLoginPassword	Senha de logon do administrador do SQL	corda
virtualNetworkProfile	Perfil de Rede Virtual	VirtualNetworkProfile
workspaceRepositoryConfiguration	Configurações de integração do Git	WorkspaceRepositoryConfiguration

WorkspacePropertiesConnectivityEndpoints

Nome	Descrição	Valor

WorkspaceRepositoryConfiguration

Nome	Descrição	Valor
accountName	Nome da conta	corda
collaborationBranch	Branch de colaboração	corda
hostName	Nome do host do GitHub Enterprise. Por exemplo: `https://github.mydomain.com`	corda
lastCommitId	A última ID de confirmação	corda
projectName	Nome do projeto do VSTS	corda
repositórioName	Nome do repositório	corda
rootFolder	Pasta raiz a ser usada no repositório	corda
tenantId	A ID do locatário do VSTS	corda Restrições: Comprimento mínimo = 36 Comprimento máximo = 36 Padrão = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
tipo	Tipo de configuração de repositório de workspaceID. Exemplo de WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration	corda

Definição de recurso de modelo do ARM

O tipo de recurso de workspaces pode ser implantado com operações direcionadas:

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

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

Formato de recurso

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

{
  "type": "Microsoft.Synapse/workspaces",
  "apiVersion": "2021-03-01",
  "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 propriedade

CustomerManagedKeyDetails

Nome	Descrição	Valor
chave	O objeto chave do workspace	WorkspaceKeyDetails

DataLakeStorageAccountDetails

Nome	Descrição	Valor
accountUrl	URL da conta	corda
sistema de arquivos	Nome do sistema de arquivos	corda

EncryptionDetails

Nome	Descrição	Valor
cmk	Detalhes da chave gerenciada pelo cliente	CustomerManagedKeyDetails

ManagedIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade gerenciada para o workspace	'None' 'SystemAssigned'

ManagedVirtualNetworkSettings

Nome	Descrição	Valor
allowedAadTenantIdsForLinking	IDs de locatário do Aad permitidas para vinculação	string[]
linkedAccessCheckOnTargetResource	Verificação de acesso vinculado no recurso de destino	Bool
preventDataExfiltration	Impedir exfiltração de dados	Bool

Microsoft.Synapse/workspaces

Nome	Descrição	Valor
apiVersion	A versão da API	'2021-03-01'
identidade	Identidade do workspace	ManagedIdentity
localização	A localização geográfica onde o recurso reside	cadeia de caracteres (obrigatório)
nome	O nome do recurso	cadeia de caracteres (obrigatório)
Propriedades	Propriedades do recurso do workspace	WorkspaceProperties
Tags	Marcas de recurso	Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo	O tipo de recurso	'Microsoft.Synapse/workspaces'

PrivateEndpoint

Nome	Descrição	Valor

PrivateEndpointConnection

Nome	Descrição	Valor
Propriedades	Propriedades de conexão de ponto de extremidade privado.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

Nome	Descrição	Valor
descrição	A descrição da conexão do serviço de link privado.	corda
estado	O status da conexão do serviço de link privado.	corda

PurviewConfiguration

Nome	Descrição	Valor
purviewResourceId	ID do recurso do Purview	corda

TrackedResourceTags

Nome	Descrição	Valor

VirtualNetworkProfile

Nome	Descrição	Valor
computeSubnetId	ID de sub-rede usada para computação no workspace	corda

WorkspaceKeyDetails

Nome	Descrição	Valor
keyVaultUrl	URL do cofre de chaves de sub-recurso da Chave do Workspace	corda
nome	Nome do subprocurso da chave do workspace	corda

WorkspaceProperties

Nome	Descrição	Valor
connectivityEndpoints	Pontos de extremidade de conectividade	WorkspacePropertiesConnectivityEndpoints
defaultDataLakeStorage	Detalhes da conta de armazenamento do data lake padrão do workspace	DataLakeStorageAccountDetails
encriptação	Os detalhes de criptografia do workspace	EncryptionDetails
managedResourceGroupName	Grupo de recursos gerenciados do workspace. O nome do grupo de recursos identifica exclusivamente o grupo de recursos dentro da subscriptionId do usuário. O nome do grupo de recursos não deve ter mais de 90 caracteres e deve ter caracteres alfanuméricos (Char.IsLetterOrDigit()) e '-', '_', '(', ')' e'. Observe que o nome não pode terminar com '.'	corda
managedVirtualNetwork	Definir isso como "padrão" garantirá que toda a computação para esse workspace esteja em uma rede virtual gerenciada em nome do usuário.	corda
managedVirtualNetworkSettings	Configurações de rede virtual gerenciada	ManagedVirtualNetworkSettings
privateEndpointConnections	Conexões de ponto de extremidade privado com o workspace	PrivateEndpointConnection []
publicNetworkAccess	Habilitar ou desabilitar o acesso à rede pública ao workspace	'Desabilitado' 'Habilitado'
purviewConfiguration	Configuração do Purview	PurviewConfiguration
sqlAdministratorLogin	Logon do administrador do active directory do SQL do workspace	corda
sqlAdministratorLoginPassword	Senha de logon do administrador do SQL	corda
virtualNetworkProfile	Perfil de Rede Virtual	VirtualNetworkProfile
workspaceRepositoryConfiguration	Configurações de integração do Git	WorkspaceRepositoryConfiguration

WorkspacePropertiesConnectivityEndpoints

Nome	Descrição	Valor

WorkspaceRepositoryConfiguration

Nome	Descrição	Valor
accountName	Nome da conta	corda
collaborationBranch	Branch de colaboração	corda
hostName	Nome do host do GitHub Enterprise. Por exemplo: `https://github.mydomain.com`	corda
lastCommitId	A última ID de confirmação	corda
projectName	Nome do projeto do VSTS	corda
repositórioName	Nome do repositório	corda
rootFolder	Pasta raiz a ser usada no repositório	corda
tenantId	A ID do locatário do VSTS	corda Restrições: Comprimento mínimo = 36 Comprimento máximo = 36 Padrão = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
tipo	Tipo de configuração de repositório de workspaceID. Exemplo de WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration	corda

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
de Prova de Conceito do Azure Synapse	Este modelo cria uma prova de ambiente de conceito para o Azure Synapse, incluindo pools de SQL e pools opcionais do Apache Spark

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso de workspaces pode ser implantado com operações direcionadas:

grupos de recursos

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces@2021-03-01"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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 propriedade

CustomerManagedKeyDetails

Nome	Descrição	Valor
chave	O objeto chave do workspace	WorkspaceKeyDetails

DataLakeStorageAccountDetails

Nome	Descrição	Valor
accountUrl	URL da conta	corda
sistema de arquivos	Nome do sistema de arquivos	corda

EncryptionDetails

Nome	Descrição	Valor
cmk	Detalhes da chave gerenciada pelo cliente	CustomerManagedKeyDetails

ManagedIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade gerenciada para o workspace	'None' 'SystemAssigned'

ManagedVirtualNetworkSettings

Nome	Descrição	Valor
allowedAadTenantIdsForLinking	IDs de locatário do Aad permitidas para vinculação	string[]
linkedAccessCheckOnTargetResource	Verificação de acesso vinculado no recurso de destino	Bool
preventDataExfiltration	Impedir exfiltração de dados	Bool

Microsoft.Synapse/workspaces

Nome	Descrição	Valor
identidade	Identidade do workspace	ManagedIdentity
localização	A localização geográfica onde o recurso reside	cadeia de caracteres (obrigatório)
nome	O nome do recurso	cadeia de caracteres (obrigatório)
Propriedades	Propriedades do recurso do workspace	WorkspaceProperties
Tags	Marcas de recurso	Dicionário de nomes e valores de marca.
tipo	O tipo de recurso	"Microsoft.Synapse/workspaces@2021-03-01"

PrivateEndpoint

Nome	Descrição	Valor

PrivateEndpointConnection

Nome	Descrição	Valor
Propriedades	Propriedades de conexão de ponto de extremidade privado.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

Nome	Descrição	Valor
descrição	A descrição da conexão do serviço de link privado.	corda
estado	O status da conexão do serviço de link privado.	corda

PurviewConfiguration

Nome	Descrição	Valor
purviewResourceId	ID do recurso do Purview	corda

TrackedResourceTags

Nome	Descrição	Valor

VirtualNetworkProfile

Nome	Descrição	Valor
computeSubnetId	ID de sub-rede usada para computação no workspace	corda

WorkspaceKeyDetails

Nome	Descrição	Valor
keyVaultUrl	URL do cofre de chaves de sub-recurso da Chave do Workspace	corda
nome	Nome do subprocurso da chave do workspace	corda

WorkspaceProperties

Nome	Descrição	Valor
connectivityEndpoints	Pontos de extremidade de conectividade	WorkspacePropertiesConnectivityEndpoints
defaultDataLakeStorage	Detalhes da conta de armazenamento do data lake padrão do workspace	DataLakeStorageAccountDetails
encriptação	Os detalhes de criptografia do workspace	EncryptionDetails
managedResourceGroupName	Grupo de recursos gerenciados do workspace. O nome do grupo de recursos identifica exclusivamente o grupo de recursos dentro da subscriptionId do usuário. O nome do grupo de recursos não deve ter mais de 90 caracteres e deve ter caracteres alfanuméricos (Char.IsLetterOrDigit()) e '-', '_', '(', ')' e'. Observe que o nome não pode terminar com '.'	corda
managedVirtualNetwork	Definir isso como "padrão" garantirá que toda a computação para esse workspace esteja em uma rede virtual gerenciada em nome do usuário.	corda
managedVirtualNetworkSettings	Configurações de rede virtual gerenciada	ManagedVirtualNetworkSettings
privateEndpointConnections	Conexões de ponto de extremidade privado com o workspace	PrivateEndpointConnection []
publicNetworkAccess	Habilitar ou desabilitar o acesso à rede pública ao workspace	'Desabilitado' 'Habilitado'
purviewConfiguration	Configuração do Purview	PurviewConfiguration
sqlAdministratorLogin	Logon do administrador do active directory do SQL do workspace	corda
sqlAdministratorLoginPassword	Senha de logon do administrador do SQL	corda
virtualNetworkProfile	Perfil de Rede Virtual	VirtualNetworkProfile
workspaceRepositoryConfiguration	Configurações de integração do Git	WorkspaceRepositoryConfiguration

WorkspacePropertiesConnectivityEndpoints

Nome	Descrição	Valor

WorkspaceRepositoryConfiguration

Nome	Descrição	Valor
accountName	Nome da conta	corda
collaborationBranch	Branch de colaboração	corda
hostName	Nome do host do GitHub Enterprise. Por exemplo: `https://github.mydomain.com`	corda
lastCommitId	A última ID de confirmação	corda
projectName	Nome do projeto do VSTS	corda
repositórioName	Nome do repositório	corda
rootFolder	Pasta raiz a ser usada no repositório	corda
tenantId	A ID do locatário do VSTS	corda Restrições: Comprimento mínimo = 36 Comprimento máximo = 36 Padrão = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
tipo	Tipo de configuração de repositório de workspaceID. Exemplo de WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration	corda

Compartilhar via

Workspaces do Microsoft.Synapse 2021-03-01

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

CustomerManagedKeyDetails

DataLakeStorageAccountDetails

EncryptionDetails

ManagedIdentity

ManagedVirtualNetworkSettings

Microsoft.Synapse/workspaces

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PurviewConfiguration

TrackedResourceTags

VirtualNetworkProfile

WorkspaceKeyDetails

WorkspaceProperties

WorkspacePropertiesConnectivityEndpoints

WorkspaceRepositoryConfiguration

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

CustomerManagedKeyDetails

DataLakeStorageAccountDetails

EncryptionDetails

ManagedIdentity

ManagedVirtualNetworkSettings

Microsoft.Synapse/workspaces

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PurviewConfiguration

TrackedResourceTags

VirtualNetworkProfile

WorkspaceKeyDetails

WorkspaceProperties

WorkspacePropertiesConnectivityEndpoints

WorkspaceRepositoryConfiguration

Modelos de início rápido

Definição de recurso do Terraform (provedor de AzAPI)

Formato de recurso

Valores de propriedade

CustomerManagedKeyDetails

DataLakeStorageAccountDetails

EncryptionDetails

ManagedIdentity

ManagedVirtualNetworkSettings

Microsoft.Synapse/workspaces

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PurviewConfiguration

TrackedResourceTags

VirtualNetworkProfile

WorkspaceKeyDetails

WorkspaceProperties

WorkspacePropertiesConnectivityEndpoints

WorkspaceRepositoryConfiguration

Comentários

Recursos adicionais