Microsoft.Synapse ワークスペース 2020-12-01

Bicep リソース定義

ワークスペース リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Synapse/workspaces リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Synapse/workspaces@2020-12-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
  }
  properties: {
    connectivityEndpoints: {}
    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'
          }
        }
      }
    ]
    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'
    }
  }
}

プロパティ値

workspaces

名前 説明
name リソース名 string (必須)

文字制限: 1 から 50

有効な文字:
小文字、ハイフン、および数字。

先頭と末尾には、文字または数字を使用します。

-ondemand を含むことはできません

リソース名は、Azure 全体で一意である必要があります。
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
identity ワークスペースの ID ManagedIdentity
properties ワークスペース リソースのプロパティ WorkspaceProperties

ManagedIdentity

Name 説明
type ワークスペースのマネージド ID の種類 'None'
'SystemAssigned'

WorkspaceProperties

Name 説明
connectivityEndpoints 接続エンドポイント object
defaultDataLakeStorage ワークスペースの既定のデータ レイク ストレージ アカウントの詳細 DataLakeStorageAccountDetails
暗号化 (encryption) ワークスペースの暗号化の詳細 EncryptionDetails
managedResourceGroupName ワークスペースマネージド リソース グループ。 リソース グループ名は、ユーザー subscriptionId 内のリソース グループを一意に識別します。 リソース グループ名の長さは 90 文字以下で、英数字 (Char.IsLetterOrDigit())、'-'、'_'、'(''、')' である必要があります。 名前は '.' で終わることはできません。 string
managedVirtualNetwork これを 'default' に設定すると、このワークスペースのすべてのコンピューティングが、ユーザーの代わりに管理される仮想ネットワーク内に存在することが保証されます。 string
managedVirtualNetworkSettings マネージド Virtual Networkの設定 ManagedVirtualNetworkSettings
privateEndpointConnections ワークスペースへのプライベート エンドポイント接続 PrivateEndpointConnection[]
purviewConfiguration Purview の構成 PurviewConfiguration
sqlAdministratorLogin ワークスペース SQL Active Directory 管理者のログイン string
sqlAdministratorLoginPassword SQL 管理者ログイン パスワード string
virtualNetworkProfile Virtual Network プロファイル VirtualNetworkProfile
workspaceRepositoryConfiguration Git 統合の設定 WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

名前 説明
accountUrl アカウント URL string
filesystem ファイルシステム名 string

EncryptionDetails

名前 説明
Cmk カスタマー マネージド キーの詳細 CustomerManagedKeyDetails

CustomerManagedKeyDetails

Name 説明
キー ワークスペースのキー オブジェクト WorkspaceKeyDetails

WorkspaceKeyDetails

名前 説明
keyVaultUrl ワークスペース キー サブリソース キー コンテナーの URL string
name ワークスペース キーサブリソース名 string

ManagedVirtualNetworkSettings

名前 説明
allowedAadTenantIdsForLinking リンクに使用できる Aad テナント ID string[]
linkedAccessCheckOnTargetResource ターゲット リソースでのリンクされたアクセス チェック [bool]
preventDataExfiltration データ流出の防止 [bool]

PrivateEndpointConnection

Name 説明
properties プライベート エンドポイント接続プロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 説明
privateEndpoint 接続が属するプライベート エンドポイント。 PrivateEndpoint
privateLinkServiceConnectionState プライベート エンドポイント接続の接続状態。 PrivateLinkServiceConnectionState

PrivateEndpoint

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

PrivateLinkServiceConnectionState

Name 説明
description プライベート リンク サービス接続の説明。 string
status プライベート リンク サービスの接続状態。 string

PurviewConfiguration

名前 説明
purviewResourceId Purview リソース ID string

VirtualNetworkProfile

名前 説明
computeSubnetId ワークスペース内のコンピューティングに使用されるサブネット ID string

WorkspaceRepositoryConfiguration

名前 説明
accountName アカウント名 string
collaborationBranch コラボレーション ブランチ string
hostName GitHub Enterprise ホスト名。 例: https://github.mydomain.com string
lastCommitId 最後のコミット ID string
projectName VSTS プロジェクト名 string
repositoryName リポジトリ名です string
rootFolder リポジトリで使用するルート フォルダー string
tenantId VSTS テナント ID string
type ワークスペース リポジトリ ID 構成の種類。 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration の例 string

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
Azure Synapse 概念実証

Azure にデプロイする
このテンプレートは、SQL プールやオプションの Apache Spark プールなど、Azure Synapseの概念実証環境を作成します

ARM テンプレート リソース定義

ワークスペースリソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Synapse/workspaces リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Synapse/workspaces",
  "apiVersion": "2020-12-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string"
  },
  "properties": {
    "connectivityEndpoints": {},
    "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"
          }
        }
      }
    ],
    "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"
    }
  }
}

プロパティ値

workspaces

名前 説明
type リソースの種類 'Microsoft.Synapse/workspaces'
apiVersion リソース API のバージョン '2020-12-01'
name リソース名 string (必須)

文字数制限: 1 から 50

有効な文字:
小文字、ハイフン、および数字。

先頭と末尾には、文字または数字を使用します。

-ondemand を含むことはできません

リソース名は、Azure 全体で一意である必要があります。
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
identity ワークスペースの ID ManagedIdentity
properties ワークスペース リソースのプロパティ WorkspaceProperties

ManagedIdentity

Name 説明
type ワークスペースのマネージド ID の種類 'None'
'SystemAssigned'

WorkspaceProperties

Name 説明
connectivityEndpoints 接続エンドポイント object
defaultDataLakeStorage ワークスペースの既定のデータ レイク ストレージ アカウントの詳細 DataLakeStorageAccountDetails
暗号化 (encryption) ワークスペースの暗号化の詳細 EncryptionDetails
managedResourceGroupName ワークスペースマネージド リソース グループ。 リソース グループ名は、ユーザー subscriptionId 内のリソース グループを一意に識別します。 リソース グループ名の長さは 90 文字以下で、英数字 (Char.IsLetterOrDigit()) と '-'、'_'、'('、')' 、'' である必要があります。 名前は '.' で終わることはできません。 string
managedVirtualNetwork これを "default" に設定すると、このワークスペースのすべてのコンピューティングが、ユーザーの代わりに管理される仮想ネットワーク内に確実に存在します。 string
managedVirtualNetworkSettings マネージド Virtual Networkの設定 ManagedVirtualNetworkSettings
privateEndpointConnections ワークスペースへのプライベート エンドポイント接続 PrivateEndpointConnection[]
purviewConfiguration Purview の構成 PurviewConfiguration
sqlAdministratorLogin ワークスペース SQL Active Directory 管理者のログイン string
sqlAdministratorLoginPassword SQL 管理者ログイン パスワード string
virtualNetworkProfile プロファイルのVirtual Network VirtualNetworkProfile
workspaceRepositoryConfiguration Git 統合の設定 WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Name 説明
accountUrl アカウント URL string
filesystem ファイルシステム名 string

EncryptionDetails

Name 説明
Cmk カスタマー マネージド キーの詳細 CustomerManagedKeyDetails

CustomerManagedKeyDetails

Name 説明
キー ワークスペースのキー オブジェクト WorkspaceKeyDetails

WorkspaceKeyDetails

Name 説明
keyVaultUrl ワークスペース キー サブリソース キー コンテナーの URL string
name ワークスペース キーサブリソース名 string

ManagedVirtualNetworkSettings

Name 説明
allowedAadTenantIdsForLinking リンクに使用できる Aad テナント ID string[]
linkedAccessCheckOnTargetResource ターゲット リソースでのリンクされたアクセス チェック bool
preventDataExfiltration データ流出の防止 [bool]

PrivateEndpointConnection

Name 説明
properties プライベート エンドポイント接続プロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 説明
privateEndpoint 接続が属するプライベート エンドポイント。 PrivateEndpoint
privateLinkServiceConnectionState プライベート エンドポイント接続の接続状態。 PrivateLinkServiceConnectionState

PrivateEndpoint

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

PrivateLinkServiceConnectionState

名前 説明
description プライベート リンク サービス接続の説明。 string
status プライベート リンク サービスの接続状態。 string

PurviewConfiguration

Name 説明
purviewResourceId Purview リソース ID string

VirtualNetworkProfile

名前 説明
computeSubnetId ワークスペース内のコンピューティングに使用されるサブネット ID string

WorkspaceRepositoryConfiguration

名前 説明
accountName アカウント名 string
collaborationBranch コラボレーション ブランチ string
hostName GitHub Enterprise ホスト名。 例: https://github.mydomain.com string
lastCommitId 最後のコミット ID string
projectName VSTS プロジェクト名 string
repositoryName リポジトリ名です string
rootFolder リポジトリで使用するルート フォルダー string
tenantId VSTS テナント ID string
type ワークスペース リポジトリ ID 構成の種類。 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration の例 string

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
Azure Synapse 概念実証

Azure にデプロイする
このテンプレートは、SQL プールやオプションの Apache Spark プールなど、Azure Synapseの概念実証環境を作成します

Terraform (AzAPI プロバイダー) リソース定義

ワークスペースリソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Synapse/workspaces リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces@2020-12-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      connectivityEndpoints = {}
      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"
            }
          }
        }
      ]
      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"
      }
    }
  })
}

プロパティ値

workspaces

名前 説明
type リソースの種類 "Microsoft.Synapse/workspaces@2020-12-01"
name リソース名 string (必須)

文字数制限: 1 から 50

有効な文字:
小文字、ハイフン、および数字。

先頭と末尾には、文字または数字を使用します。

-ondemand を含むことはできません

リソース名は、Azure 全体で一意である必要があります。
location リソースが保存されている地理的な場所 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。
identity ワークスペースの ID ManagedIdentity
properties ワークスペース リソースのプロパティ WorkspaceProperties

ManagedIdentity

名前 説明
type ワークスペースのマネージド ID の種類 "SystemAssigned"

WorkspaceProperties

Name 説明
connectivityEndpoints 接続エンドポイント object
defaultDataLakeStorage ワークスペースの既定のデータ レイク ストレージ アカウントの詳細 DataLakeStorageAccountDetails
暗号化 (encryption) ワークスペースの暗号化の詳細 EncryptionDetails
managedResourceGroupName ワークスペースマネージド リソース グループ。 リソース グループ名は、ユーザー subscriptionId 内のリソース グループを一意に識別します。 リソース グループ名の長さは 90 文字以下で、英数字 (Char.IsLetterOrDigit()) と '-'、'_'、'('、')' 、'' である必要があります。 名前は '.' で終わることはできません。 string
managedVirtualNetwork これを "default" に設定すると、このワークスペースのすべてのコンピューティングが、ユーザーの代わりに管理される仮想ネットワーク内に確実に存在します。 string
managedVirtualNetworkSettings マネージド Virtual Networkの設定 ManagedVirtualNetworkSettings
privateEndpointConnections ワークスペースへのプライベート エンドポイント接続 PrivateEndpointConnection[]
purviewConfiguration Purview の構成 PurviewConfiguration
sqlAdministratorLogin ワークスペース SQL Active Directory 管理者のログイン string
sqlAdministratorLoginPassword SQL 管理者ログイン パスワード string
virtualNetworkProfile プロファイルのVirtual Network VirtualNetworkProfile
workspaceRepositoryConfiguration Git 統合の設定 WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Name 説明
accountUrl アカウント URL string
filesystem ファイルシステム名 string

EncryptionDetails

Name 説明
Cmk カスタマー マネージド キーの詳細 CustomerManagedKeyDetails

CustomerManagedKeyDetails

Name 説明
キー ワークスペースのキー オブジェクト WorkspaceKeyDetails

WorkspaceKeyDetails

Name 説明
keyVaultUrl ワークスペース キー サブリソース キー コンテナーの URL string
name ワークスペース キーサブリソース名 string

ManagedVirtualNetworkSettings

名前 説明
allowedAadTenantIdsForLinking リンクに使用できる Aad テナント ID string[]
linkedAccessCheckOnTargetResource ターゲット リソースでのリンクされたアクセス チェック bool
preventDataExfiltration データ流出の防止 [bool]

PrivateEndpointConnection

名前 説明
properties プライベート エンドポイント接続プロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 説明
privateEndpoint 接続が属するプライベート エンドポイント。 PrivateEndpoint
privateLinkServiceConnectionState プライベート エンドポイント接続の接続状態。 PrivateLinkServiceConnectionState

PrivateEndpoint

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

PrivateLinkServiceConnectionState

Name 説明
description プライベート リンク サービス接続の説明。 string
status プライベート リンク サービスの接続状態。 string

PurviewConfiguration

名前 説明
purviewResourceId Purview リソース ID string

VirtualNetworkProfile

名前 説明
computeSubnetId ワークスペース内のコンピューティングに使用されるサブネット ID string

WorkspaceRepositoryConfiguration

名前 説明
accountName アカウント名 string
collaborationBranch コラボレーション ブランチ string
hostName GitHub Enterprise ホスト名。 例: https://github.mydomain.com string
lastCommitId 最後のコミット ID string
projectName VSTS プロジェクト名 string
repositoryName リポジトリ名です string
rootFolder リポジトリで使用するルート フォルダー string
tenantId VSTS テナント ID string
type ワークスペース リポジトリ ID 構成の種類。 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration の例 string