Microsoft.Synapse ワークスペース 2021-03-01

[アーティクル]
07/01/2023

Bicep リソース定義

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

リソースグループ - リソースグループのデプロイコマンドに関するページを参照してください

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

リソース形式

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

resource symbolicname 'Microsoft.Synapse/workspaces@2021-03-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'
          }
        }
      }
    ]
    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'
    }
  }
}

プロパティ値

workspaces

名前	説明	値
name	リソース名	string (必須) 文字数制限: 1 から 50 有効な文字: 小文字、ハイフン、および数字。先頭と末尾には、文字または数字を使用します。 `-ondemand` を含むことはできませんリソース名は、Azure 全体で一意である必要があります。
location	リソースが保存されている地理的な場所	string (必須)
tags	リソースタグ。	タグ名と値のディクショナリ。「テンプレートのタグ」を参照してください
identity	ワークスペースの ID	ManagedIdentity
properties	ワークスペースリソースのプロパティ	WorkspaceProperties

ManagedIdentity

名前	説明	値
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[]
publicNetworkAccess	ワークスペースへのパブリックネットワークアクセスを有効または無効にする	'Disabled' 'Enabled'
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

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

WorkspaceRepositoryConfiguration

Name	説明	値
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 概念実証	このテンプレートは、SQL プールやオプションの Apache Spark プールなど、Azure Synapseの概念実証環境を作成します

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

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

リソースグループ - リソースグループのデプロイコマンドを参照してください

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

リソース形式

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

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

プロパティ値

workspaces

名前	説明	値
type	リソースの種類	'Microsoft.Synapse/workspaces'
apiVersion	リソース API のバージョン	'2021-03-01'
name	リソース名	string (必須) 文字制限: 1 から 50 有効な文字: 小文字、ハイフン、および数字。先頭と末尾には、文字または数字を使用します。 `-ondemand` を含むことはできませんリソース名は、Azure 全体で一意である必要があります。
location	リソースが保存されている地理的な場所	string (必須)
tags	リソースタグ。	タグの名前と値のディクショナリ。「テンプレート内のタグ」を参照してください
identity	ワークスペースの ID	ManagedIdentity
properties	ワークスペースリソースのプロパティ	WorkspaceProperties

ManagedIdentity

名前	説明	値
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[]
publicNetworkAccess	ワークスペースへのパブリックネットワークアクセスを有効または無効にする	'Disabled' 'Enabled'
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

名前	説明	値
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 概念実証	このテンプレートは、SQL プールやオプションの Apache Spark プールなど、Azure Synapseの概念実証環境を作成します

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

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

リソースグループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces@2021-03-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"
            }
          }
        }
      ]
      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"
      }
    }
  })
}

プロパティ値

workspaces

Name	説明	値
type	リソースの種類	"Microsoft.Synapse/workspaces@2021-03-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[]
publicNetworkAccess	ワークスペースへのパブリックネットワークアクセスを有効または無効にする	"無効" "有効"
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

名前	説明	値
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

次の方法で共有

Microsoft.Synapse ワークスペース 2021-03-01

Bicep リソース定義

リソース形式

プロパティ値

workspaces

ManagedIdentity

WorkspaceProperties

DataLakeStorageAccountDetails

EncryptionDetails

CustomerManagedKeyDetails

WorkspaceKeyDetails

ManagedVirtualNetworkSettings

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

PrivateLinkServiceConnectionState

PurviewConfiguration

VirtualNetworkProfile

WorkspaceRepositoryConfiguration

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

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

リソース形式

プロパティ値

workspaces

ManagedIdentity

WorkspaceProperties

DataLakeStorageAccountDetails

EncryptionDetails

CustomerManagedKeyDetails

WorkspaceKeyDetails

ManagedVirtualNetworkSettings

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

PrivateLinkServiceConnectionState

PurviewConfiguration

VirtualNetworkProfile

WorkspaceRepositoryConfiguration

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

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

リソース形式

プロパティ値

workspaces

ManagedIdentity

WorkspaceProperties

DataLakeStorageAccountDetails

EncryptionDetails

CustomerManagedKeyDetails

WorkspaceKeyDetails

ManagedVirtualNetworkSettings

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

PrivateLinkServiceConnectionState

PurviewConfiguration

VirtualNetworkProfile

WorkspaceRepositoryConfiguration

フィードバック

フィードバック

その他のリソース

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

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

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