Microsoft.Synapse ワークスペース 2021-04-01-preview
- [アーティクル]
-
-
Bicep リソース定義
ワークスペース リソースの種類は、次を対象とする操作でデプロイできます。
-
リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.Synapse/workspaces リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Synapse/workspaces@2021-04-01-preview' = {
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'
}
}
プロパティ値
CustomerManagedKeyDetails
DataLakeStorageAccountDetails
| 名前 |
形容 |
価値 |
| accountUrl |
アカウント URL |
糸 |
| filesystem |
ファイルシステム名 |
糸 |
EncryptionDetails
ManagedIdentity
| 名前 |
形容 |
価値 |
| 種類 |
ワークスペースのマネージド ID の種類 |
'None'
'SystemAssigned' |
ManagedVirtualNetworkSettings
| 名前 |
形容 |
価値 |
| allowedAadTenantIdsForLinking |
リンクに使用できる Aad テナント ID |
string[] |
| linkedAccessCheckOnTargetResource |
ターゲット リソースのリンクされたアクセス チェック |
bool |
| preventDataExfiltration |
データ流出の防止 |
bool |
Microsoft.Synapse/workspaces
| 名前 |
形容 |
価値 |
| 同一性 |
ワークスペースの ID |
ManagedIdentity |
| 場所 |
リソースが存在する地理的な場所 |
string (必須) |
| 名前 |
リソース名 |
string (必須) |
| プロパティ |
ワークスペース リソースのプロパティ |
WorkspaceProperties |
| タグ |
リソース タグ |
タグ名と値のディクショナリ。 テンプレート の タグを参照してください |
PrivateEndpoint
PrivateEndpointConnection
PrivateEndpointConnectionProperties
| 名前 |
形容 |
価値 |
| privateEndpoint |
接続が属するプライベート エンドポイント。 |
PrivateEndpoint を する |
| privateLinkServiceConnectionState |
プライベート エンドポイント接続の接続状態。 |
PrivateLinkServiceConnectionState を する |
PrivateLinkServiceConnectionState
| 名前 |
形容 |
価値 |
| 形容 |
プライベート リンク サービスの接続の説明。 |
糸 |
| 地位 |
プライベート リンク サービスの接続状態。 |
糸 |
PurviewConfiguration
| 名前 |
形容 |
価値 |
| purviewResourceId |
Purview リソース ID |
糸 |
VirtualNetworkProfile
| 名前 |
形容 |
価値 |
| computeSubnetId |
ワークスペース内のコンピューティングに使用されるサブネット ID |
糸 |
WorkspaceKeyDetails
| 名前 |
形容 |
価値 |
| keyVaultUrl |
ワークスペース キー サブリソース キー コンテナーの URL |
糸 |
| 名前 |
ワークスペース キーのサブリソース名 |
糸 |
WorkspaceProperties
| 名前 |
形容 |
価値 |
| connectivityEndpoints |
接続エンドポイント |
WorkspacePropertiesConnectivityEndpoints |
| defaultDataLakeStorage |
ワークスペースの既定の Data Lake ストレージ アカウントの詳細 |
DataLakeStorageAccountDetails の |
| 暗号化 |
ワークスペースの暗号化の詳細 |
EncryptionDetails |
| managedResourceGroupName |
ワークスペースマネージド リソース グループ。 リソース グループ名は、ユーザー subscriptionId 内のリソース グループを一意に識別します。 リソース グループ名の長さは 90 文字以下で、英数字 (Char.IsLetterOrDigit())、'-'、'_'、'('、')'、'') である必要があります。 名前は '.' で終わることはできません。 |
糸 |
| managedVirtualNetwork |
これを "default" に設定すると、このワークスペースのすべてのコンピューティングが、ユーザーの代わりに管理される仮想ネットワーク内に存在することが保証されます。 |
糸 |
| managedVirtualNetworkSettings |
マネージド仮想ネットワークの設定 |
ManagedVirtualNetworkSettings の |
| privateEndpointConnections |
ワークスペースへのプライベート エンドポイント接続 |
PrivateEndpointConnection[] |
| publicNetworkAccess |
ワークスペースへのパブリック ネットワーク アクセスを有効または無効にする |
'Disabled'
'Enabled' |
| purviewConfiguration |
Purview の構成 |
PurviewConfiguration |
| sqlAdministratorLogin |
ワークスペース SQL Active Directory 管理者のログイン |
糸 |
| sqlAdministratorLoginPassword |
SQL 管理者ログイン パスワード |
糸 |
| virtualNetworkProfile |
Virtual Network プロファイル |
VirtualNetworkProfile の |
| workspaceRepositoryConfiguration |
Git 統合設定 |
WorkspaceRepositoryConfiguration |
WorkspacePropertiesConnectivityEndpoints
WorkspaceRepositoryConfiguration
| 名前 |
形容 |
価値 |
| accountName |
アカウント名 |
糸 |
| collaborationBranch |
コラボレーション ブランチ |
糸 |
| hostName |
GitHub Enterprise ホスト名。 例: https://github.mydomain.com |
糸 |
| lastCommitId |
最後のコミット ID |
糸 |
| projectName |
VSTS プロジェクト名 |
糸 |
| repositoryName |
リポジトリ名 |
糸 |
| rootFolder |
リポジトリで使用するルート フォルダー |
糸 |
| tenantId |
VSTS テナント ID |
糸
制約：
最小長 = 36
最大長 = 36
パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| 種類 |
ワークスペース リポジトリ ID 構成の種類。 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration の例 |
糸 |
ARM テンプレート リソース定義
ワークスペース リソースの種類は、次を対象とする操作でデプロイできます。
-
リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.Synapse/workspaces リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Synapse/workspaces",
"apiVersion": "2021-04-01-preview",
"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"
}
}
プロパティ値
CustomerManagedKeyDetails
DataLakeStorageAccountDetails
| 名前 |
形容 |
価値 |
| accountUrl |
アカウント URL |
糸 |
| filesystem |
ファイルシステム名 |
糸 |
EncryptionDetails
ManagedIdentity
| 名前 |
形容 |
価値 |
| 種類 |
ワークスペースのマネージド ID の種類 |
'None'
'SystemAssigned' |
ManagedVirtualNetworkSettings
| 名前 |
形容 |
価値 |
| allowedAadTenantIdsForLinking |
リンクに使用できる Aad テナント ID |
string[] |
| linkedAccessCheckOnTargetResource |
ターゲット リソースのリンクされたアクセス チェック |
bool |
| preventDataExfiltration |
データ流出の防止 |
bool |
Microsoft.Synapse/workspaces
| 名前 |
形容 |
価値 |
| apiVersion |
API のバージョン |
'2021-04-01-preview' |
| 同一性 |
ワークスペースの ID |
ManagedIdentity |
| 場所 |
リソースが存在する地理的な場所 |
string (必須) |
| 名前 |
リソース名 |
string (必須) |
| プロパティ |
ワークスペース リソースのプロパティ |
WorkspaceProperties |
| タグ |
リソース タグ |
タグ名と値のディクショナリ。 テンプレート の タグを参照してください |
| 種類 |
リソースの種類 |
'Microsoft.Synapse/workspaces' |
PrivateEndpoint
PrivateEndpointConnection
PrivateEndpointConnectionProperties
| 名前 |
形容 |
価値 |
| privateEndpoint |
接続が属するプライベート エンドポイント。 |
PrivateEndpoint を する |
| privateLinkServiceConnectionState |
プライベート エンドポイント接続の接続状態。 |
PrivateLinkServiceConnectionState を する |
PrivateLinkServiceConnectionState
| 名前 |
形容 |
価値 |
| 形容 |
プライベート リンク サービスの接続の説明。 |
糸 |
| 地位 |
プライベート リンク サービスの接続状態。 |
糸 |
PurviewConfiguration
| 名前 |
形容 |
価値 |
| purviewResourceId |
Purview リソース ID |
糸 |
VirtualNetworkProfile
| 名前 |
形容 |
価値 |
| computeSubnetId |
ワークスペース内のコンピューティングに使用されるサブネット ID |
糸 |
WorkspaceKeyDetails
| 名前 |
形容 |
価値 |
| keyVaultUrl |
ワークスペース キー サブリソース キー コンテナーの URL |
糸 |
| 名前 |
ワークスペース キーのサブリソース名 |
糸 |
WorkspaceProperties
| 名前 |
形容 |
価値 |
| connectivityEndpoints |
接続エンドポイント |
WorkspacePropertiesConnectivityEndpoints |
| defaultDataLakeStorage |
ワークスペースの既定の Data Lake ストレージ アカウントの詳細 |
DataLakeStorageAccountDetails の |
| 暗号化 |
ワークスペースの暗号化の詳細 |
EncryptionDetails |
| managedResourceGroupName |
ワークスペースマネージド リソース グループ。 リソース グループ名は、ユーザー subscriptionId 内のリソース グループを一意に識別します。 リソース グループ名の長さは 90 文字以下で、英数字 (Char.IsLetterOrDigit())、'-'、'_'、'('、')'、'') である必要があります。 名前は '.' で終わることはできません。 |
糸 |
| managedVirtualNetwork |
これを "default" に設定すると、このワークスペースのすべてのコンピューティングが、ユーザーの代わりに管理される仮想ネットワーク内に存在することが保証されます。 |
糸 |
| managedVirtualNetworkSettings |
マネージド仮想ネットワークの設定 |
ManagedVirtualNetworkSettings の |
| privateEndpointConnections |
ワークスペースへのプライベート エンドポイント接続 |
PrivateEndpointConnection[] |
| publicNetworkAccess |
ワークスペースへのパブリック ネットワーク アクセスを有効または無効にする |
'Disabled'
'Enabled' |
| purviewConfiguration |
Purview の構成 |
PurviewConfiguration |
| sqlAdministratorLogin |
ワークスペース SQL Active Directory 管理者のログイン |
糸 |
| sqlAdministratorLoginPassword |
SQL 管理者ログイン パスワード |
糸 |
| virtualNetworkProfile |
Virtual Network プロファイル |
VirtualNetworkProfile の |
| workspaceRepositoryConfiguration |
Git 統合設定 |
WorkspaceRepositoryConfiguration |
WorkspacePropertiesConnectivityEndpoints
WorkspaceRepositoryConfiguration
| 名前 |
形容 |
価値 |
| accountName |
アカウント名 |
糸 |
| collaborationBranch |
コラボレーション ブランチ |
糸 |
| hostName |
GitHub Enterprise ホスト名。 例: https://github.mydomain.com |
糸 |
| lastCommitId |
最後のコミット ID |
糸 |
| projectName |
VSTS プロジェクト名 |
糸 |
| repositoryName |
リポジトリ名 |
糸 |
| rootFolder |
リポジトリで使用するルート フォルダー |
糸 |
| tenantId |
VSTS テナント ID |
糸
制約：
最小長 = 36
最大長 = 36
パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| 種類 |
ワークスペース リポジトリ ID 構成の種類。 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration の例 |
糸 |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
| テンプレート |
形容 |
Azure Synapse 概念実証
Azure にデプロイする |
このテンプレートは、SQL プールやオプションの Apache Spark プールなど、Azure Synapse の概念実証環境を作成します |
ワークスペース リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.Synapse/workspaces リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Synapse/workspaces@2021-04-01-preview"
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"
}
}
})
}
プロパティ値
CustomerManagedKeyDetails
DataLakeStorageAccountDetails
| 名前 |
形容 |
価値 |
| accountUrl |
アカウント URL |
糸 |
| filesystem |
ファイルシステム名 |
糸 |
EncryptionDetails
ManagedIdentity
| 名前 |
形容 |
価値 |
| 種類 |
ワークスペースのマネージド ID の種類 |
'None'
'SystemAssigned' |
ManagedVirtualNetworkSettings
| 名前 |
形容 |
価値 |
| allowedAadTenantIdsForLinking |
リンクに使用できる Aad テナント ID |
string[] |
| linkedAccessCheckOnTargetResource |
ターゲット リソースのリンクされたアクセス チェック |
bool |
| preventDataExfiltration |
データ流出の防止 |
bool |
Microsoft.Synapse/workspaces
| 名前 |
形容 |
価値 |
| 同一性 |
ワークスペースの ID |
ManagedIdentity |
| 場所 |
リソースが存在する地理的な場所 |
string (必須) |
| 名前 |
リソース名 |
string (必須) |
| プロパティ |
ワークスペース リソースのプロパティ |
WorkspaceProperties |
| タグ |
リソース タグ |
タグ名と値のディクショナリ。 |
| 種類 |
リソースの種類 |
"Microsoft.Synapse/workspaces@2021-04-01-preview" |
PrivateEndpoint
PrivateEndpointConnection
PrivateEndpointConnectionProperties
| 名前 |
形容 |
価値 |
| privateEndpoint |
接続が属するプライベート エンドポイント。 |
PrivateEndpoint を する |
| privateLinkServiceConnectionState |
プライベート エンドポイント接続の接続状態。 |
PrivateLinkServiceConnectionState を する |
PrivateLinkServiceConnectionState
| 名前 |
形容 |
価値 |
| 形容 |
プライベート リンク サービスの接続の説明。 |
糸 |
| 地位 |
プライベート リンク サービスの接続状態。 |
糸 |
PurviewConfiguration
| 名前 |
形容 |
価値 |
| purviewResourceId |
Purview リソース ID |
糸 |
VirtualNetworkProfile
| 名前 |
形容 |
価値 |
| computeSubnetId |
ワークスペース内のコンピューティングに使用されるサブネット ID |
糸 |
WorkspaceKeyDetails
| 名前 |
形容 |
価値 |
| keyVaultUrl |
ワークスペース キー サブリソース キー コンテナーの URL |
糸 |
| 名前 |
ワークスペース キーのサブリソース名 |
糸 |
WorkspaceProperties
| 名前 |
形容 |
価値 |
| connectivityEndpoints |
接続エンドポイント |
WorkspacePropertiesConnectivityEndpoints |
| defaultDataLakeStorage |
ワークスペースの既定の Data Lake ストレージ アカウントの詳細 |
DataLakeStorageAccountDetails の |
| 暗号化 |
ワークスペースの暗号化の詳細 |
EncryptionDetails |
| managedResourceGroupName |
ワークスペースマネージド リソース グループ。 リソース グループ名は、ユーザー subscriptionId 内のリソース グループを一意に識別します。 リソース グループ名の長さは 90 文字以下で、英数字 (Char.IsLetterOrDigit())、'-'、'_'、'('、')'、'') である必要があります。 名前は '.' で終わることはできません。 |
糸 |
| managedVirtualNetwork |
これを "default" に設定すると、このワークスペースのすべてのコンピューティングが、ユーザーの代わりに管理される仮想ネットワーク内に存在することが保証されます。 |
糸 |
| managedVirtualNetworkSettings |
マネージド仮想ネットワークの設定 |
ManagedVirtualNetworkSettings の |
| privateEndpointConnections |
ワークスペースへのプライベート エンドポイント接続 |
PrivateEndpointConnection[] |
| publicNetworkAccess |
ワークスペースへのパブリック ネットワーク アクセスを有効または無効にする |
'Disabled'
'Enabled' |
| purviewConfiguration |
Purview の構成 |
PurviewConfiguration |
| sqlAdministratorLogin |
ワークスペース SQL Active Directory 管理者のログイン |
糸 |
| sqlAdministratorLoginPassword |
SQL 管理者ログイン パスワード |
糸 |
| virtualNetworkProfile |
Virtual Network プロファイル |
VirtualNetworkProfile の |
| workspaceRepositoryConfiguration |
Git 統合設定 |
WorkspaceRepositoryConfiguration |
WorkspacePropertiesConnectivityEndpoints
WorkspaceRepositoryConfiguration
| 名前 |
形容 |
価値 |
| accountName |
アカウント名 |
糸 |
| collaborationBranch |
コラボレーション ブランチ |
糸 |
| hostName |
GitHub Enterprise ホスト名。 例: https://github.mydomain.com |
糸 |
| lastCommitId |
最後のコミット ID |
糸 |
| projectName |
VSTS プロジェクト名 |
糸 |
| repositoryName |
リポジトリ名 |
糸 |
| rootFolder |
リポジトリで使用するルート フォルダー |
糸 |
| tenantId |
VSTS テナント ID |
糸
制約：
最小長 = 36
最大長 = 36
パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| 種類 |
ワークスペース リポジトリ ID 構成の種類。 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration の例 |
糸 |