Microsoft.Synapse ワークスペース
- [アーティクル]
-
-
Bicep リソース定義
ワークスペースリソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.Synapse/workspaces リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Synapse/workspaces@2021-06-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
azureADOnlyAuthentication: bool
cspWorkspaceAdminProperties: {
initialWorkspaceAdminObjectId: 'string'
}
defaultDataLakeStorage: {
accountUrl: 'string'
createManagedPrivateEndpoint: bool
filesystem: 'string'
resourceId: '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'
trustedServiceBypassEnabled: bool
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' 'SystemAssigned,UserAssigned' |
userAssignedIdentities |
ユーザー割り当てマネージド ID。 |
object |
WorkspaceProperties
Name |
説明 |
値 |
azureADOnlyAuthentication |
すべてのワークスペース サブリソースで AzureADOnlyAuthentication を有効または無効にする |
[bool] |
cspWorkspaceAdminProperties |
CSP サブスクリプションの初期ワークスペース AAD 管理者プロパティ |
CspWorkspaceAdminProperties |
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 |
trustedServiceBypassEnabled |
ワークスペースの trustedServiceBypassEnabled です |
[bool] |
virtualNetworkProfile |
Virtual Network プロファイル |
VirtualNetworkProfile |
workspaceRepositoryConfiguration |
Git 統合の設定 |
WorkspaceRepositoryConfiguration |
CspWorkspaceAdminProperties
名前 |
説明 |
値 |
initialWorkspaceAdminObjectId |
初期ワークスペース管理者の AAD オブジェクト ID |
string |
DataLakeStorageAccountDetails
名前 |
説明 |
値 |
accountUrl |
アカウント URL |
string |
createManagedPrivateEndpoint |
このストレージ アカウントに対してマネージド プライベート エンドポイントを作成するかどうか |
[bool] |
filesystem |
ファイルシステム名 |
string |
resourceId |
このストレージ アカウントの ARM リソース ID |
string |
EncryptionDetails
CustomerManagedKeyDetails
KekIdentityProperties
名前 |
説明 |
値 |
userAssignedIdentity |
ユーザー割り当て ID リソース ID |
string |
useSystemAssignedIdentity |
システム割り当て ID を使用するかどうかを指定するブール値 |
Bicep の場合は、 any() 関数を使用できます。 |
WorkspaceKeyDetails
名前 |
説明 |
値 |
keyVaultUrl |
ワークスペース キー サブリソース キー コンテナーの URL |
string |
name |
ワークスペース キーサブリソース名 |
string |
ManagedVirtualNetworkSettings
名前 |
説明 |
値 |
allowedAadTenantIdsForLinking |
リンクに使用できる Aad テナント ID |
string[] |
linkedAccessCheckOnTargetResource |
ターゲット リソースのリンクされたアクセス チェック |
[bool] |
preventDataExfiltration |
データ流出の防止 |
[bool] |
PrivateEndpointConnection
PrivateEndpointConnectionProperties
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 概念実証
|
このテンプレートは、SQL プールやオプションの Apache Spark プールなど、Azure Synapseの概念実証環境を作成します |
ARM テンプレート リソース定義
ワークスペース リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.Synapse/workspaces リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Synapse/workspaces",
"apiVersion": "2021-06-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"azureADOnlyAuthentication": "bool",
"cspWorkspaceAdminProperties": {
"initialWorkspaceAdminObjectId": "string"
},
"defaultDataLakeStorage": {
"accountUrl": "string",
"createManagedPrivateEndpoint": "bool",
"filesystem": "string",
"resourceId": "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",
"trustedServiceBypassEnabled": "bool",
"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-06-01' |
name |
リソース名 |
string (必須)
文字制限: 1 から 50
有効な文字: 小文字、ハイフン、および数字。
先頭と末尾には、文字または数字を使用します。
-ondemand を含むことはできません
リソース名は、Azure 全体で一意である必要があります。 |
location |
リソースが保存されている地理的な場所 |
string (必須) |
tags |
リソース タグ。 |
タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
identity |
ワークスペースの ID |
ManagedIdentity |
properties |
ワークスペース リソースのプロパティ |
WorkspaceProperties |
ManagedIdentity
Name |
説明 |
値 |
type |
ワークスペースのマネージド ID の種類 |
'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' |
userAssignedIdentities |
ユーザー割り当てマネージド ID。 |
object |
WorkspaceProperties
Name |
説明 |
値 |
azureADOnlyAuthentication |
すべてのワークスペース サブリソースで AzureADOnlyAuthentication を有効または無効にする |
[bool] |
cspWorkspaceAdminProperties |
CSP サブスクリプションの初期ワークスペース AAD 管理者プロパティ |
CspWorkspaceAdminProperties |
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 |
trustedServiceBypassEnabled |
ワークスペースの trustedServiceBypassEnabled です |
[bool] |
virtualNetworkProfile |
Virtual Network プロファイル |
VirtualNetworkProfile |
workspaceRepositoryConfiguration |
Git 統合の設定 |
WorkspaceRepositoryConfiguration |
CspWorkspaceAdminProperties
Name |
説明 |
値 |
initialWorkspaceAdminObjectId |
初期ワークスペース管理者の AAD オブジェクト ID |
string |
DataLakeStorageAccountDetails
Name |
説明 |
値 |
accountUrl |
アカウント URL |
string |
createManagedPrivateEndpoint |
このストレージ アカウントに対してマネージド プライベート エンドポイントを作成するかどうか |
[bool] |
filesystem |
ファイルシステム名 |
string |
resourceId |
このストレージ アカウントの ARM リソース ID |
string |
EncryptionDetails
CustomerManagedKeyDetails
KekIdentityProperties
Name |
説明 |
値 |
userAssignedIdentity |
ユーザー割り当て ID リソース ID |
string |
useSystemAssignedIdentity |
システム割り当て ID を使用するかどうかを指定するブール値 |
|
WorkspaceKeyDetails
Name |
説明 |
値 |
keyVaultUrl |
ワークスペース キー サブリソース キー コンテナーの URL |
string |
name |
ワークスペース キーサブリソース名 |
string |
ManagedVirtualNetworkSettings
Name |
説明 |
値 |
allowedAadTenantIdsForLinking |
リンクに使用できる Aad テナント ID |
string[] |
linkedAccessCheckOnTargetResource |
ターゲット リソースのリンクされたアクセス チェック |
bool |
preventDataExfiltration |
データ流出の防止 |
bool |
PrivateEndpointConnection
PrivateEndpointConnectionProperties
PrivateEndpoint
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
PrivateLinkServiceConnectionState
Name |
説明 |
値 |
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の概念実証環境を作成します |
ワークスペースリソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.Synapse/workspaces リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Synapse/workspaces@2021-06-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
azureADOnlyAuthentication = bool
cspWorkspaceAdminProperties = {
initialWorkspaceAdminObjectId = "string"
}
defaultDataLakeStorage = {
accountUrl = "string"
createManagedPrivateEndpoint = bool
filesystem = "string"
resourceId = "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"
trustedServiceBypassEnabled = bool
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@2021-06-01" |
name |
リソース名 |
string (必須)
文字数制限: 1 から 50
有効な文字: 小文字、ハイフン、および数字。
先頭と末尾には、文字または数字を使用します。
-ondemand を含むことはできません
リソース名は、Azure 全体で一意である必要があります。 |
location |
リソースが保存されている地理的な場所 |
string (必須) |
parent_id |
リソース グループにデプロイするには、そのリソース グループの ID を使用します。 |
string (必須) |
tags |
リソース タグ。 |
タグ名と値のディクショナリ。 |
identity |
ワークスペースの ID |
ManagedIdentity |
properties |
ワークスペース リソースのプロパティ |
WorkspaceProperties |
ManagedIdentity
Name |
説明 |
値 |
type |
ワークスペースのマネージド ID の種類 |
"SystemAssigned" "SystemAssigned,UserAssigned" |
identity_ids |
ユーザー割り当てマネージド ID。 |
ユーザー ID ID の配列。 |
WorkspaceProperties
Name |
説明 |
値 |
azureADOnlyAuthentication |
すべてのワークスペース サブリソースで AzureADOnlyAuthentication を有効または無効にする |
bool |
cspWorkspaceAdminProperties |
CSP サブスクリプションの初期ワークスペース AAD 管理者プロパティ |
CspWorkspaceAdminProperties |
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 |
trustedServiceBypassEnabled |
ワークスペースの trustedServiceBypassEnabled |
[bool] |
virtualNetworkProfile |
プロファイルのVirtual Network |
VirtualNetworkProfile |
workspaceRepositoryConfiguration |
Git 統合の設定 |
WorkspaceRepositoryConfiguration |
CspWorkspaceAdminProperties
名前 |
説明 |
値 |
initialWorkspaceAdminObjectId |
初期ワークスペース管理者の AAD オブジェクト ID |
string |
DataLakeStorageAccountDetails
名前 |
説明 |
値 |
accountUrl |
アカウント URL |
string |
createManagedPrivateEndpoint |
このストレージ アカウントへのマネージド プライベート エンドポイントを作成するかどうか |
[bool] |
filesystem |
ファイルシステム名 |
string |
resourceId |
このストレージ アカウントの ARM リソース ID |
string |
EncryptionDetails
CustomerManagedKeyDetails
KekIdentityProperties
Name |
説明 |
値 |
userAssignedIdentity |
ユーザー割り当て ID リソース ID |
string |
useSystemAssignedIdentity |
システム割り当て ID を使用するかどうかを指定するブール値 |
|
WorkspaceKeyDetails
名前 |
説明 |
値 |
keyVaultUrl |
ワークスペース キー サブリソース キー コンテナーの URL |
string |
name |
ワークスペース キーサブリソース名 |
string |
ManagedVirtualNetworkSettings
名前 |
説明 |
値 |
allowedAadTenantIdsForLinking |
リンクに使用できる Aad テナント ID |
string[] |
linkedAccessCheckOnTargetResource |
ターゲット リソースでのリンクされたアクセス チェック |
[bool] |
preventDataExfiltration |
データ流出の防止 |
bool |
PrivateEndpointConnection
PrivateEndpointConnectionProperties
PrivateEndpoint
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
PrivateLinkServiceConnectionState
Name |
説明 |
値 |
description |
プライベート リンク サービス接続の説明。 |
string |
status |
プライベート リンク サービスの接続状態。 |
string |
PurviewConfiguration
名前 |
説明 |
値 |
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 |