Workspaces - Create Or Update

Служба:

Synapse

Версия API:

2021-06-01

Создание или обновление рабочей области

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}?api-version=2021-06-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
workspaceName	path	True	string	Имя рабочей области.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Текст запроса

Имя	Обязательно	Тип	Описание
location	True	string	Географическое расположение, в котором находится ресурс
identity		ManagedIdentity	Удостоверение рабочей области
properties.azureADOnlyAuthentication		boolean	Включение или отключение AzureADOnlyAuthentication в подресурсе всех рабочих областей
properties.cspWorkspaceAdminProperties		CspWorkspaceAdminProperties	Свойства администратора AAD для начальной рабочей области для подписки CSP
properties.defaultDataLakeStorage		DataLakeStorageAccountDetails	Сведения о учетной записи хранения озера данных по умолчанию рабочей области
properties.encryption		EncryptionDetails	Сведения о шифровании рабочей области
properties.managedResourceGroupName		string	Управляемая рабочая область группы ресурсов. Имя группы ресурсов однозначно идентифицирует группу ресурсов в идентификаторе подписки пользователя. Имя группы ресурсов должно быть не более 90 символов, и должно быть буквенно-цифровыми символами (Char.IsLetterOrDigit()) и "-", "_", "(", ")" и". Обратите внимание, что имя не может заканчиваться "".
properties.managedVirtualNetwork		string	Если для этой рабочей области задано значение default, все вычислительные ресурсы этой рабочей области будут находиться в виртуальной сети, управляемой от имени пользователя.
properties.managedVirtualNetworkSettings		ManagedVirtualNetworkSettings	Параметры управляемой виртуальной сети
properties.privateEndpointConnections		PrivateEndpointConnection[]	Подключения частной конечной точки к рабочей области
properties.publicNetworkAccess		WorkspacePublicNetworkAccess	Включение или отключение доступа к рабочей области общедоступной сети
properties.purviewConfiguration		PurviewConfiguration	Конфигурация Purview
properties.sqlAdministratorLogin		string	Вход для администратора Active Directory рабочей области SQL
properties.sqlAdministratorLoginPassword		string	Пароль для входа администратора SQL
properties.trustedServiceBypassEnabled		boolean	Является довереннымServiceBypassEnabled для рабочей области
properties.virtualNetworkProfile		VirtualNetworkProfile	Профиль виртуальной сети
properties.workspaceRepositoryConfiguration		WorkspaceRepositoryConfiguration	Параметры интеграции Git
tags		object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	Workspace
201 Created	Workspace
Other Status Codes	ErrorResponse

Примеры

Create or update a workspace

Образец запроса

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1?api-version=2021-06-01

{
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": {}
    }
  },
  "properties": {
    "defaultDataLakeStorage": {
      "accountUrl": "https://accountname.dfs.core.windows.net",
      "filesystem": "default"
    },
    "managedVirtualNetworkSettings": {
      "preventDataExfiltration": false,
      "linkedAccessCheckOnTargetResource": false,
      "allowedAadTenantIdsForLinking": [
        "740239CE-A25B-485B-86A0-262F29F6EBDB"
      ]
    },
    "purviewConfiguration": {
      "purviewResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"
    },
    "sqlAdministratorLogin": "login",
    "sqlAdministratorLoginPassword": "password",
    "managedVirtualNetwork": "default",
    "managedResourceGroupName": "workspaceManagedResourceGroupUnique",
    "workspaceRepositoryConfiguration": {
      "type": "FactoryGitHubConfiguration",
      "hostName": "",
      "accountName": "mygithubaccount",
      "projectName": "myproject",
      "repositoryName": "myrepository",
      "collaborationBranch": "master",
      "rootFolder": "/"
    },
    "encryption": {
      "cmk": {
        "kekIdentity": {
          "userAssignedIdentity": "/subscriptions/b64d7b94-73e7-4d36-94b2-7764ea3fd74a/resourcegroups/SynapseCI/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1",
          "useSystemAssignedIdentity": false
        },
        "key": {
          "name": "default",
          "keyVaultUrl": "https://vault.azure.net/keys/key1"
        }
      }
    },
    "publicNetworkAccess": "Enabled",
    "cspWorkspaceAdminProperties": {
      "initialWorkspaceAdminObjectId": "6c20646f-8050-49ec-b3b1-80a0e58e454d"
    }
  },
  "location": "East US",
  "tags": {
    "key": "value"
  }
}

Java

import com.azure.resourcemanager.synapse.models.CspWorkspaceAdminProperties;
import com.azure.resourcemanager.synapse.models.CustomerManagedKeyDetails;
import com.azure.resourcemanager.synapse.models.DataLakeStorageAccountDetails;
import com.azure.resourcemanager.synapse.models.EncryptionDetails;
import com.azure.resourcemanager.synapse.models.KekIdentityProperties;
import com.azure.resourcemanager.synapse.models.ManagedIdentity;
import com.azure.resourcemanager.synapse.models.ManagedVirtualNetworkSettings;
import com.azure.resourcemanager.synapse.models.PurviewConfiguration;
import com.azure.resourcemanager.synapse.models.ResourceIdentityType;
import com.azure.resourcemanager.synapse.models.UserAssignedManagedIdentity;
import com.azure.resourcemanager.synapse.models.WorkspaceKeyDetails;
import com.azure.resourcemanager.synapse.models.WorkspacePublicNetworkAccess;
import com.azure.resourcemanager.synapse.models.WorkspaceRepositoryConfiguration;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Workspaces CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateWorkspace.json
     */
    /**
     * Sample code: Create or update a workspace.
     * 
     * @param manager Entry point to SynapseManager.
     */
    public static void createOrUpdateAWorkspace(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager.workspaces().define("workspace1").withRegion("East US").withExistingResourceGroup("resourceGroup1")
            .withTags(mapOf("key", "fakeTokenPlaceholder"))
            .withIdentity(new ManagedIdentity().withType(ResourceIdentityType.SYSTEM_ASSIGNED_USER_ASSIGNED)
                .withUserAssignedIdentities(mapOf(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1",
                    new UserAssignedManagedIdentity())))
            .withDefaultDataLakeStorage(new DataLakeStorageAccountDetails()
                .withAccountUrl("https://accountname.dfs.core.windows.net").withFilesystem("default"))
            .withSqlAdministratorLoginPassword("password")
            .withManagedResourceGroupName("workspaceManagedResourceGroupUnique").withSqlAdministratorLogin("login")
            .withManagedVirtualNetwork("default")
            .withEncryption(new EncryptionDetails().withCmk(new CustomerManagedKeyDetails()
                .withKey(new WorkspaceKeyDetails().withName("default").withKeyVaultUrl("fakeTokenPlaceholder"))
                .withKekIdentity(new KekIdentityProperties().withUserAssignedIdentity(
                    "/subscriptions/b64d7b94-73e7-4d36-94b2-7764ea3fd74a/resourcegroups/SynapseCI/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1")
                    .withUseSystemAssignedIdentity(false))))
            .withManagedVirtualNetworkSettings(new ManagedVirtualNetworkSettings().withPreventDataExfiltration(false)
                .withLinkedAccessCheckOnTargetResource(false)
                .withAllowedAadTenantIdsForLinking(Arrays.asList("740239CE-A25B-485B-86A0-262F29F6EBDB")))
            .withWorkspaceRepositoryConfiguration(
                new WorkspaceRepositoryConfiguration().withType("FactoryGitHubConfiguration").withHostname("")
                    .withAccountName("mygithubaccount").withProjectName("myproject").withRepositoryName("myrepository")
                    .withCollaborationBranch("master").withRootFolder("/"))
            .withPurviewConfiguration(new PurviewConfiguration().withPurviewResourceId(
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"))
            .withPublicNetworkAccess(WorkspacePublicNetworkAccess.ENABLED)
            .withCspWorkspaceAdminProperties(new CspWorkspaceAdminProperties()
                .withInitialWorkspaceAdminObjectId("6c20646f-8050-49ec-b3b1-80a0e58e454d"))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python create_or_update_workspace.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.workspaces.begin_create_or_update(
        resource_group_name="resourceGroup1",
        workspace_name="workspace1",
        workspace_info={
            "identity": {
                "type": "SystemAssigned,UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": {}
                },
            },
            "location": "East US",
            "properties": {
                "cspWorkspaceAdminProperties": {
                    "initialWorkspaceAdminObjectId": "6c20646f-8050-49ec-b3b1-80a0e58e454d"
                },
                "defaultDataLakeStorage": {
                    "accountUrl": "https://accountname.dfs.core.windows.net",
                    "filesystem": "default",
                },
                "encryption": {
                    "cmk": {
                        "kekIdentity": {
                            "useSystemAssignedIdentity": False,
                            "userAssignedIdentity": "/subscriptions/b64d7b94-73e7-4d36-94b2-7764ea3fd74a/resourcegroups/SynapseCI/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1",
                        },
                        "key": {"keyVaultUrl": "https://vault.azure.net/keys/key1", "name": "default"},
                    }
                },
                "managedResourceGroupName": "workspaceManagedResourceGroupUnique",
                "managedVirtualNetwork": "default",
                "managedVirtualNetworkSettings": {
                    "allowedAadTenantIdsForLinking": ["740239CE-A25B-485B-86A0-262F29F6EBDB"],
                    "linkedAccessCheckOnTargetResource": False,
                    "preventDataExfiltration": False,
                },
                "publicNetworkAccess": "Enabled",
                "purviewConfiguration": {
                    "purviewResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"
                },
                "sqlAdministratorLogin": "login",
                "sqlAdministratorLoginPassword": "password",
                "workspaceRepositoryConfiguration": {
                    "accountName": "mygithubaccount",
                    "collaborationBranch": "master",
                    "hostName": "",
                    "projectName": "myproject",
                    "repositoryName": "myrepository",
                    "rootFolder": "/",
                    "type": "FactoryGitHubConfiguration",
                },
            },
            "tags": {"key": "value"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateWorkspace.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateWorkspace.json
func ExampleWorkspacesClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspacesClient().BeginCreateOrUpdate(ctx, "resourceGroup1", "workspace1", armsynapse.Workspace{
		Location: to.Ptr("East US"),
		Tags: map[string]*string{
			"key": to.Ptr("value"),
		},
		Identity: &armsynapse.ManagedIdentity{
			Type: to.Ptr(armsynapse.ResourceIdentityTypeSystemAssignedUserAssigned),
			UserAssignedIdentities: map[string]*armsynapse.UserAssignedManagedIdentity{
				"/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": {},
			},
		},
		Properties: &armsynapse.WorkspaceProperties{
			CspWorkspaceAdminProperties: &armsynapse.CspWorkspaceAdminProperties{
				InitialWorkspaceAdminObjectID: to.Ptr("6c20646f-8050-49ec-b3b1-80a0e58e454d"),
			},
			DefaultDataLakeStorage: &armsynapse.DataLakeStorageAccountDetails{
				AccountURL: to.Ptr("https://accountname.dfs.core.windows.net"),
				Filesystem: to.Ptr("default"),
			},
			Encryption: &armsynapse.EncryptionDetails{
				Cmk: &armsynapse.CustomerManagedKeyDetails{
					KekIdentity: &armsynapse.KekIdentityProperties{
						UseSystemAssignedIdentity: false,
						UserAssignedIdentity:      to.Ptr("/subscriptions/b64d7b94-73e7-4d36-94b2-7764ea3fd74a/resourcegroups/SynapseCI/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1"),
					},
					Key: &armsynapse.WorkspaceKeyDetails{
						Name:        to.Ptr("default"),
						KeyVaultURL: to.Ptr("https://vault.azure.net/keys/key1"),
					},
				},
			},
			ManagedResourceGroupName: to.Ptr("workspaceManagedResourceGroupUnique"),
			ManagedVirtualNetwork:    to.Ptr("default"),
			ManagedVirtualNetworkSettings: &armsynapse.ManagedVirtualNetworkSettings{
				AllowedAADTenantIDsForLinking: []*string{
					to.Ptr("740239CE-A25B-485B-86A0-262F29F6EBDB")},
				LinkedAccessCheckOnTargetResource: to.Ptr(false),
				PreventDataExfiltration:           to.Ptr(false),
			},
			PublicNetworkAccess: to.Ptr(armsynapse.WorkspacePublicNetworkAccessEnabled),
			PurviewConfiguration: &armsynapse.PurviewConfiguration{
				PurviewResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"),
			},
			SQLAdministratorLogin:         to.Ptr("login"),
			SQLAdministratorLoginPassword: to.Ptr("password"),
			WorkspaceRepositoryConfiguration: &armsynapse.WorkspaceRepositoryConfiguration{
				Type:                to.Ptr("FactoryGitHubConfiguration"),
				AccountName:         to.Ptr("mygithubaccount"),
				CollaborationBranch: to.Ptr("master"),
				HostName:            to.Ptr(""),
				ProjectName:         to.Ptr("myproject"),
				RepositoryName:      to.Ptr("myrepository"),
				RootFolder:          to.Ptr("/"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Workspace = armsynapse.Workspace{
	// 	Name: to.Ptr("workspace1"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Identity: &armsynapse.ManagedIdentity{
	// 		Type: to.Ptr(armsynapse.ResourceIdentityTypeSystemAssignedUserAssigned),
	// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 		UserAssignedIdentities: map[string]*armsynapse.UserAssignedManagedIdentity{
	// 			"/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": &armsynapse.UserAssignedManagedIdentity{
	// 				ClientID: to.Ptr("ffffffff-8888-4444-8888-333333333333"),
	// 				PrincipalID: to.Ptr("eeeeeeee-9999-4444-8888-333333333333"),
	// 			},
	// 		},
	// 	},
	// 	Properties: &armsynapse.WorkspaceProperties{
	// 		ConnectivityEndpoints: map[string]*string{
	// 			"dev": to.Ptr("workspace1.dev.projectarcadia.net"),
	// 			"sql": to.Ptr("workspace1.sql.projectarcadia.net"),
	// 		},
	// 		DefaultDataLakeStorage: &armsynapse.DataLakeStorageAccountDetails{
	// 			AccountURL: to.Ptr("https://accountname.dfs.core.windows.net"),
	// 			Filesystem: to.Ptr("default"),
	// 		},
	// 		Encryption: &armsynapse.EncryptionDetails{
	// 			Cmk: &armsynapse.CustomerManagedKeyDetails{
	// 				KekIdentity: &armsynapse.KekIdentityProperties{
	// 					UseSystemAssignedIdentity: false,
	// 					UserAssignedIdentity: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1"),
	// 				},
	// 				Key: &armsynapse.WorkspaceKeyDetails{
	// 					Name: to.Ptr("default"),
	// 					KeyVaultURL: to.Ptr("https://vault.azure.net/keys/key1"),
	// 				},
	// 				Status: to.Ptr("Consistent"),
	// 			},
	// 			DoubleEncryptionEnabled: to.Ptr(true),
	// 		},
	// 		ManagedResourceGroupName: to.Ptr("workspaceManagedResourceGroupUnique"),
	// 		ManagedVirtualNetwork: to.Ptr("default"),
	// 		ManagedVirtualNetworkSettings: &armsynapse.ManagedVirtualNetworkSettings{
	// 			AllowedAADTenantIDsForLinking: []*string{
	// 				to.Ptr("740239CE-A25B-485B-86A0-262F29F6EBDB")},
	// 				LinkedAccessCheckOnTargetResource: to.Ptr(false),
	// 				PreventDataExfiltration: to.Ptr(false),
	// 			},
	// 			PrivateEndpointConnections: []*armsynapse.PrivateEndpointConnection{
	// 				{
	// 					Name: to.Ptr("sql"),
	// 					Type: to.Ptr("Microsoft.Synapse/workspaces/privateEndpointConnections"),
	// 					ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection"),
	// 					Properties: &armsynapse.PrivateEndpointConnectionProperties{
	// 						PrivateEndpoint: &armsynapse.PrivateEndpoint{
	// 							ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"),
	// 						},
	// 						PrivateLinkServiceConnectionState: &armsynapse.PrivateLinkServiceConnectionState{
	// 							Description: to.Ptr("Auto-approved"),
	// 							ActionsRequired: to.Ptr("None"),
	// 							Status: to.Ptr("Approved"),
	// 						},
	// 						ProvisioningState: to.Ptr("Succeeded"),
	// 					},
	// 			}},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			PublicNetworkAccess: to.Ptr(armsynapse.WorkspacePublicNetworkAccessEnabled),
	// 			PurviewConfiguration: &armsynapse.PurviewConfiguration{
	// 				PurviewResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"),
	// 			},
	// 			SQLAdministratorLogin: to.Ptr("login"),
	// 			WorkspaceUID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a workspace
 *
 * @summary Creates or updates a workspace
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateWorkspace.json
 */
async function createOrUpdateAWorkspace() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "resourceGroup1";
  const workspaceName = "workspace1";
  const workspaceInfo = {
    cspWorkspaceAdminProperties: {
      initialWorkspaceAdminObjectId: "6c20646f-8050-49ec-b3b1-80a0e58e454d",
    },
    defaultDataLakeStorage: {
      accountUrl: "https://accountname.dfs.core.windows.net",
      filesystem: "default",
    },
    encryption: {
      cmk: {
        kekIdentity: {
          useSystemAssignedIdentity: false,
          userAssignedIdentity:
            "/subscriptions/b64d7b94-73e7-4d36-94b2-7764ea3fd74a/resourcegroups/SynapseCI/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1",
        },
        key: {
          name: "default",
          keyVaultUrl: "https://vault.azure.net/keys/key1",
        },
      },
    },
    identity: {
      type: "SystemAssigned,UserAssigned",
      userAssignedIdentities: {
        "/subscriptions/00000000111122223333444444444444/resourcegroups/resourceGroup1/providers/MicrosoftManagedIdentity/userAssignedIdentities/uami1":
          {},
      },
    },
    location: "East US",
    managedResourceGroupName: "workspaceManagedResourceGroupUnique",
    managedVirtualNetwork: "default",
    managedVirtualNetworkSettings: {
      allowedAadTenantIdsForLinking: ["740239CE-A25B-485B-86A0-262F29F6EBDB"],
      linkedAccessCheckOnTargetResource: false,
      preventDataExfiltration: false,
    },
    publicNetworkAccess: "Enabled",
    purviewConfiguration: {
      purviewResourceId:
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1",
    },
    sqlAdministratorLogin: "login",
    sqlAdministratorLoginPassword: "password",
    tags: { key: "value" },
    workspaceRepositoryConfiguration: {
      type: "FactoryGitHubConfiguration",
      accountName: "mygithubaccount",
      collaborationBranch: "master",
      hostName: "",
      projectName: "myproject",
      repositoryName: "myrepository",
      rootFolder: "/",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result = await client.workspaces.beginCreateOrUpdateAndWait(
    resourceGroupName,
    workspaceName,
    workspaceInfo
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Synapse.Models;
using Azure.ResourceManager.Synapse;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateWorkspace.json
// this example is just showing the usage of "Workspaces_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "resourceGroup1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this SynapseWorkspaceResource
SynapseWorkspaceCollection collection = resourceGroupResource.GetSynapseWorkspaces();

// invoke the operation
string workspaceName = "workspace1";
SynapseWorkspaceData data = new SynapseWorkspaceData(new AzureLocation("East US"))
{
    Identity = new ManagedServiceIdentity("SystemAssigned,UserAssigned")
    {
        UserAssignedIdentities =
        {
        [new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1")] = new UserAssignedIdentity()
        },
    },
    DefaultDataLakeStorage = new SynapseDataLakeStorageAccountDetails
    {
        AccountUri = new Uri("https://accountname.dfs.core.windows.net"),
        Filesystem = "default",
    },
    SqlAdministratorLoginPassword = "password",
    ManagedResourceGroupName = "workspaceManagedResourceGroupUnique",
    SqlAdministratorLogin = "login",
    ManagedVirtualNetwork = "default",
    Encryption = new SynapseEncryptionDetails
    {
        Cmk = new WorkspaceCustomerManagedKeyDetails
        {
            Key = new SynapseWorkspaceKeyDetails
            {
                Name = "default",
                KeyVaultUri = new Uri("https://vault.azure.net/keys/key1"),
            },
            KekIdentity = new KekIdentityProperties
            {
                UserAssignedIdentityId = new ResourceIdentifier("/subscriptions/b64d7b94-73e7-4d36-94b2-7764ea3fd74a/resourcegroups/SynapseCI/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1"),
                UseSystemAssignedIdentity = BinaryData.FromObjectAsJson("false"),
            },
        },
    },
    ManagedVirtualNetworkSettings = new SynapseManagedVirtualNetworkSettings
    {
        PreventDataExfiltration = false,
        EnableLinkedAccessCheckOnTargetResource = false,
        AllowedAadTenantIdsForLinking = { "740239CE-A25B-485B-86A0-262F29F6EBDB" },
    },
    WorkspaceRepositoryConfiguration = new SynapseWorkspaceRepositoryConfiguration
    {
        WorkspaceRepositoryConfigurationType = "FactoryGitHubConfiguration",
        HostName = "",
        AccountName = "mygithubaccount",
        ProjectName = "myproject",
        RepositoryName = "myrepository",
        CollaborationBranch = "master",
        RootFolder = "/",
    },
    PurviewResourceId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"),
    PublicNetworkAccess = WorkspacePublicNetworkAccess.Enabled,
    InitialWorkspaceAdminObjectId = Guid.Parse("6c20646f-8050-49ec-b3b1-80a0e58e454d"),
    Tags =
    {
    ["key"] = "value"
    },
};
ArmOperation<SynapseWorkspaceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, workspaceName, data);
SynapseWorkspaceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SynapseWorkspaceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Пример ответа

Код состояния:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1",
  "name": "workspace1",
  "type": "Microsoft.Synapse/workspaces",
  "location": "East US",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": {
        "clientId": "ffffffff-8888-4444-8888-333333333333",
        "principalId": "eeeeeeee-9999-4444-8888-333333333333"
      }
    },
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444"
  },
  "properties": {
    "defaultDataLakeStorage": {
      "accountUrl": "https://accountname.dfs.core.windows.net",
      "filesystem": "default"
    },
    "connectivityEndpoints": {
      "dev": "workspace1.dev.projectarcadia.net",
      "sql": "workspace1.sql.projectarcadia.net"
    },
    "managedVirtualNetworkSettings": {
      "preventDataExfiltration": false,
      "linkedAccessCheckOnTargetResource": false,
      "allowedAadTenantIdsForLinking": [
        "740239CE-A25B-485B-86A0-262F29F6EBDB"
      ]
    },
    "purviewConfiguration": {
      "purviewResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"
    },
    "sqlAdministratorLogin": "login",
    "managedResourceGroupName": "workspaceManagedResourceGroupUnique",
    "managedVirtualNetwork": "default",
    "provisioningState": "Succeeded",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection",
        "name": "sql",
        "type": "Microsoft.Synapse/workspaces/privateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "workspaceUID": "00000000-1111-2222-3333-444444444444",
    "encryption": {
      "doubleEncryptionEnabled": true,
      "cmk": {
        "kekIdentity": {
          "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1",
          "useSystemAssignedIdentity": false
        },
        "status": "Consistent",
        "key": {
          "name": "default",
          "keyVaultUrl": "https://vault.azure.net/keys/key1"
        }
      }
    },
    "publicNetworkAccess": "Enabled"
  },
  "tags": {
    "key": "value"
  }
}

Код состояния:

201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1",
  "name": "workspace1",
  "type": "Microsoft.Synapse/workspaces",
  "location": "East US",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": {
        "clientId": "ffffffff-8888-4444-8888-333333333333",
        "principalId": "eeeeeeee-9999-4444-8888-333333333333"
      }
    },
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444"
  },
  "properties": {
    "defaultDataLakeStorage": {
      "accountUrl": "https://accountname.dfs.core.windows.net",
      "filesystem": "default"
    },
    "managedVirtualNetworkSettings": {
      "preventDataExfiltration": false,
      "linkedAccessCheckOnTargetResource": false,
      "allowedAadTenantIdsForLinking": [
        "740239CE-A25B-485B-86A0-262F29F6EBDB"
      ]
    },
    "purviewConfiguration": {
      "purviewResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"
    },
    "connectivityEndpoints": {
      "dev": "workspace1.dev.projectarcadia.net",
      "sql": "workspace1.sql.projectarcadia.net"
    },
    "sqlAdministratorLogin": "login",
    "managedResourceGroupName": "workspaceManagedResourceGroupUnique",
    "managedVirtualNetwork": "default",
    "provisioningState": "Provisioning",
    "workspaceUID": "86984b43-b873-4b91-bacd-2ca083a104c7",
    "encryption": {
      "doubleEncryptionEnabled": true,
      "cmk": {
        "kekIdentity": {
          "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1",
          "useSystemAssignedIdentity": false
        },
        "status": "Consistent",
        "key": {
          "name": "default",
          "keyVaultUrl": "https://vault.azure.net/keys/key1"
        }
      }
    },
    "publicNetworkAccess": "Enabled"
  },
  "tags": {
    "key": "value"
  }
}

Код состояния:

default

{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Определения

Имя	Описание
CspWorkspaceAdminProperties	Свойства администратора AAD для начальной рабочей области для подписки CSP
CustomerManagedKeyDetails	Сведения об управляемом клиентом ключе, связанном с рабочей областью
DataLakeStorageAccountDetails	Сведения о учетной записи хранения озера данных, связанной с рабочей областью
EncryptionDetails	Сведения о шифровании, связанном с рабочей областью
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
KekIdentityProperties	Свойства ключа шифрования ключей
ManagedIdentity	Управляемое удостоверение рабочей области
ManagedVirtualNetworkSettings	Параметры управляемой виртуальной сети
PrivateEndpoint	Сведения о частной конечной точке
PrivateEndpointConnection	Подключение к частной конечной точке
PrivateLinkServiceConnectionState	Сведения о состоянии подключения частной конечной точки
PurviewConfiguration	Конфигурация Purview
ResourceIdentityType	Тип управляемого удостоверения для рабочей области
UserAssignedManagedIdentity	Назначаемое пользователем управляемое удостоверение
VirtualNetworkProfile	Профиль виртуальной сети
Workspace	Рабочая область
WorkspaceKeyDetails	Сведения об управляемом клиентом ключе, связанном с рабочей областью
WorkspacePublicNetworkAccess	Включение или отключение доступа к рабочей области общедоступной сети
WorkspaceRepositoryConfiguration	Параметры интеграции Git

CspWorkspaceAdminProperties

Object

Свойства администратора AAD для начальной рабочей области для подписки CSP

Имя	Тип	Описание
initialWorkspaceAdminObjectId	string	Идентификатор объекта AAD для начального администратора рабочей области

CustomerManagedKeyDetails

Object

Сведения об управляемом клиентом ключе, связанном с рабочей областью

Имя	Тип	Описание
kekIdentity	KekIdentityProperties	Ключ шифрования ключей
key	WorkspaceKeyDetails	Ключевой объект рабочей области
status	string	Состояние управляемого клиентом ключа в рабочей области

DataLakeStorageAccountDetails

Object

Сведения о учетной записи хранения озера данных, связанной с рабочей областью

Имя	Тип	Описание
accountUrl	string	URL-адрес учетной записи
createManagedPrivateEndpoint	boolean	Создание управляемой частной конечной точки для этой учетной записи хранения или нет
filesystem	string	Имя файловой системы
resourceId	string	Идентификатор ресурса ARM этой учетной записи хранения

EncryptionDetails

Object

Сведения о шифровании, связанном с рабочей областью

Имя	Тип	Описание
cmk	CustomerManagedKeyDetails	Сведения о ключе, управляемом клиентом
doubleEncryptionEnabled	boolean	Двойное шифрование включено

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

KekIdentityProperties

Object

Свойства ключа шифрования ключей

Имя	Тип	Описание
useSystemAssignedIdentity		Логическое определение того, следует ли использовать назначенное системой удостоверение или нет
userAssignedIdentity	string	Идентификатор ресурса назначаемого пользователем удостоверения

ManagedIdentity

Object

Управляемое удостоверение рабочей области

Имя	Тип	Описание
principalId	string	Основной идентификатор управляемого удостоверения рабочей области
tenantId	string (uuid)	Идентификатор клиента управляемого удостоверения рабочей области
type	ResourceIdentityType	Тип управляемого удостоверения для рабочей области
userAssignedIdentities	<string,  UserAssignedManagedIdentity>	Назначаемые пользователем управляемые удостоверения.

ManagedVirtualNetworkSettings

Object

Параметры управляемой виртуальной сети

Имя	Тип	Описание
allowedAadTenantIdsForLinking	string[]	Разрешены идентификаторы клиента Aad для связывания
linkedAccessCheckOnTargetResource	boolean	Проверка связанного доступа на целевой ресурс
preventDataExfiltration	boolean	Предотвращение кражи данных

PrivateEndpoint

Object

Сведения о частной конечной точке

Имя	Тип	Описание
id	string	Идентификатор ресурса частной конечной точки.

PrivateEndpointConnection

Object

Подключение к частной конечной точке

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.privateEndpoint	PrivateEndpoint	Частная конечная точка, к которой принадлежит подключение.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Состояние подключения частной конечной точки.
properties.provisioningState	string	Состояние подготовки подключения к частной конечной точке.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Object

Сведения о состоянии подключения частной конечной точки

Имя	Тип	Описание
actionsRequired	string	Действия, необходимые для подключения службы приватного канала.
description	string	Описание подключения службы приватного канала.
status	string	Состояние подключения службы приватного канала.

PurviewConfiguration

Object

Конфигурация Purview

Имя	Тип	Описание
purviewResourceId	string	Идентификатор ресурса Purview

ResourceIdentityType

Перечисление

Тип управляемого удостоверения для рабочей области

Значение	Описание
None
SystemAssigned
SystemAssigned,UserAssigned

UserAssignedManagedIdentity

Object

Назначаемое пользователем управляемое удостоверение

Имя	Тип	Описание
clientId	string (uuid)	Идентификатор клиента.
principalId	string (uuid)	Идентификатор субъекта.

VirtualNetworkProfile

Object

Профиль виртуальной сети

Имя	Тип	Описание
computeSubnetId	string	Идентификатор подсети, используемый для вычислений в рабочей области

Workspace

Object

Рабочая область

Имя	Тип	Default value	Описание
id	string		Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedIdentity		Удостоверение рабочей области
location	string		Географическое расположение, в котором находится ресурс
name	string		Имя ресурса
properties.adlaResourceId	string		Идентификатор ресурса ADLA.
properties.azureADOnlyAuthentication	boolean		Включение или отключение AzureADOnlyAuthentication в подресурсе всех рабочих областей
properties.connectivityEndpoints	object		Конечные точки подключения
properties.cspWorkspaceAdminProperties	CspWorkspaceAdminProperties		Свойства администратора AAD для начальной рабочей области для подписки CSP
properties.defaultDataLakeStorage	DataLakeStorageAccountDetails		Сведения о учетной записи хранения озера данных по умолчанию рабочей области
properties.encryption	EncryptionDetails		Сведения о шифровании рабочей области
properties.extraProperties	object		Конфигурации уровня рабочей области и флаги компонентов
properties.managedResourceGroupName	string		Управляемая рабочая область группы ресурсов. Имя группы ресурсов однозначно идентифицирует группу ресурсов в идентификаторе подписки пользователя. Имя группы ресурсов должно быть не более 90 символов, и должно быть буквенно-цифровыми символами (Char.IsLetterOrDigit()) и "-", "_", "(", ")" и". Обратите внимание, что имя не может заканчиваться "".
properties.managedVirtualNetwork	string		Если для этой рабочей области задано значение default, все вычислительные ресурсы этой рабочей области будут находиться в виртуальной сети, управляемой от имени пользователя.
properties.managedVirtualNetworkSettings	ManagedVirtualNetworkSettings		Параметры управляемой виртуальной сети
properties.privateEndpointConnections	PrivateEndpointConnection[]		Подключения частной конечной точки к рабочей области
properties.provisioningState	string		Состояние подготовки ресурсов
properties.publicNetworkAccess	WorkspacePublicNetworkAccess	Enabled	Включение или отключение доступа к рабочей области общедоступной сети
properties.purviewConfiguration	PurviewConfiguration		Конфигурация Purview
properties.settings	object		Параметры рабочей области
properties.sqlAdministratorLogin	string		Вход для администратора Active Directory рабочей области SQL
properties.sqlAdministratorLoginPassword	string		Пароль для входа администратора SQL
properties.trustedServiceBypassEnabled	boolean	False	Является довереннымServiceBypassEnabled для рабочей области
properties.virtualNetworkProfile	VirtualNetworkProfile		Профиль виртуальной сети
properties.workspaceRepositoryConfiguration	WorkspaceRepositoryConfiguration		Параметры интеграции Git
properties.workspaceUID	string (uuid)		Уникальный идентификатор рабочей области
tags	object		Теги ресурсов.
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

WorkspaceKeyDetails

Object

Сведения об управляемом клиентом ключе, связанном с рабочей областью

Имя	Тип	Описание
keyVaultUrl	string	URL-адрес хранилища ключей ключа рабочей области
name	string	Имя подресурсов ключа рабочей области

WorkspacePublicNetworkAccess

Перечисление

Включение или отключение доступа к рабочей области общедоступной сети

Значение	Описание
Enabled
Disabled

WorkspaceRepositoryConfiguration

Object

Параметры интеграции Git

Имя	Тип	Описание
accountName	string	Имя учетной записи
collaborationBranch	string	Ветвь совместной работы
hostName	string	Имя узла GitHub Enterprise. Например: https://github.mydomain.com
lastCommitId	string	Последний идентификатор фиксации
projectName	string	Имя проекта VSTS
repositoryName	string	Имя репозитория
rootFolder	string	Корневая папка для использования в репозитории
tenantId	string (uuid)	Идентификатор клиента VSTS
type	string	Тип конфигурации репозитория рабочей области. Пример WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration