Workspace - Get

Service:: Synapse

Version d'API:: 2020-12-01

Obtenir l’espace de travail

GET {endpoint}/workspace?api-version=2020-12-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	Point de terminaison de développement de l’espace de travail, par exemple `https://myworkspace.dev.azuresynapse.net`.
api-version	query	True	string	Version de l’API cliente Synapse.

Réponses

Nom	Type	Description
200 OK	Workspace	Réponse réussie.
Other Status Codes	ErrorContract	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Exemples

Get Workspace Information

Exemple de requête

HTTP

GET exampleWorkspace.dev.azuresynapse.net/workspace?api-version=2020-12-01

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace",
  "location": "southeastasia",
  "name": "exampleWorkspace",
  "type": "Microsoft.Synapse/workspaces",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "tags": {},
  "properties": {
    "connectivityEndpoints": {
      "web": "https://web.azuresynapse.net?workspace=%2fsubscriptions%2f00000000-0000-0000-0000-000000000000%2fresourceGroups%2frg%2fproviders%2fMicrosoft.Synapse%2fworkspaces%2fexampleWorkspace",
      "sql": "exampleWorkspace.sql.azuresynapse.net",
      "dev": "https://exampleWorkspace.dev.azuresynapse.net",
      "sqlOnDemand": "exampleWorkspace-ondemand.sql.azuresynapse.net"
    },
    "managedResourceGroupName": "workspacemanagedrg-1a992746-f580-4fce-a696-b0373bc6959a",
    "defaultDataLakeStorage": {
      "accountUrl": "https://exampleWorkspacedfs.dfs.core.windows.net",
      "filesystem": "synapse"
    },
    "sqlAdministratorLogin": "sqladminuser",
    "privateEndpointConnections": [],
    "workspaceRepositoryConfiguration": {
      "type": "FactoryGitHubConfiguration",
      "hostName": "",
      "accountName": "myGithubAccount",
      "projectName": "myProject",
      "repositoryName": "myRepository",
      "collaborationBranch": "master",
      "rootFolder": "/"
    },
    "provisioningState": "Succeeded"
  }
}

Code d’état:: default

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

Définitions

Nom	Description
CustomerManagedKeyDetails	Détails de la clé gérée par le client associée à l’espace de travail
DataLakeStorageAccountDetails	Détails du compte de stockage data lake associé à l’espace de travail
EncryptionDetails	Détails du chiffrement associé à l’espace de travail
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorContract	Détails de l’erreur.
ErrorResponse	Réponse d’erreur
GitHubClientSecret	Informations sur la clé secrète client pour la configuration de votre propre référentiel d’applications
ManagedIdentity	Identité managée de l’espace de travail
ManagedVirtualNetworkSettings	Paramètres de réseau virtuel managé
PrivateEndpoint	Détails du point de terminaison privé
PrivateEndpointConnection	Une connexion de point de terminaison privé
PrivateLinkServiceConnectionState	Détails de l’état de connexion du point de terminaison privé
PurviewConfiguration	Purview Configuration
ResourceIdentityType	Type d’identité managée pour l’espace de travail
VirtualNetworkProfile	Profil de réseau virtuel
Workspace	Un espace de travail
WorkspaceKeyDetails	Détails de la clé gérée par le client associée à l’espace de travail
WorkspaceRepositoryConfiguration	Paramètres d’intégration Git

CustomerManagedKeyDetails

Object

Détails de la clé gérée par le client associée à l’espace de travail

Nom	Type	Description
key	WorkspaceKeyDetails	Objet clé de l’espace de travail
status	string	État de la clé gérée par le client sur l’espace de travail

DataLakeStorageAccountDetails

Object

Détails du compte de stockage data lake associé à l’espace de travail

Nom	Type	Description
accountUrl	string	URL du compte
filesystem	string	Nom du système de fichiers

EncryptionDetails

Object

Détails du chiffrement associé à l’espace de travail

Nom	Type	Description
cmk	CustomerManagedKeyDetails	Détails de la clé gérée par le client
doubleEncryptionEnabled	boolean	Double chiffrement activé

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorContract

Object

Détails de l’erreur.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur Détails de l’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

GitHubClientSecret

Object

Informations sur la clé secrète client pour la configuration de votre propre référentiel d’applications

Nom	Type	Description
byoaSecretAkvUrl	string	Apportez votre propre URL AKV de secret client d’application
byoaSecretName	string	Apportez votre propre nom de clé secrète client d’application dans AKV

ManagedIdentity

Object

Identité managée de l’espace de travail

Nom	Type	Description
principalId	string	ID principal de l’identité managée de l’espace de travail
tenantId	string (uuid)	ID de locataire de l’identité managée de l’espace de travail
type	ResourceIdentityType	Type d’identité managée pour l’espace de travail

ManagedVirtualNetworkSettings

Object

Paramètres de réseau virtuel managé

Nom	Type	Description
allowedAadTenantIdsForLinking	string[]	ID de locataire Aad autorisés pour la liaison
linkedAccessCheckOnTargetResource	boolean	Vérification de l’accès lié sur la ressource cible
preventDataExfiltration	boolean	Empêcher l’exfiltration des données

PrivateEndpoint

Object

Détails du point de terminaison privé

Nom	Type	Description
id	string	ID de ressource du point de terminaison privé.

PrivateEndpointConnection

Object

Une connexion de point de terminaison privé

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties.privateEndpoint	PrivateEndpoint	Point de terminaison privé auquel la connexion appartient.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	État de connexion de la connexion de point de terminaison privé.
properties.provisioningState	string	État d’approvisionnement de la connexion de point de terminaison privé.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateLinkServiceConnectionState

Object

Détails de l’état de connexion du point de terminaison privé

Nom	Type	Description
actionsRequired	string	Actions requises pour la connexion de service de liaison privée.
description	string	Description de la connexion du service private link.
status	string	État de connexion du service de liaison privée.

PurviewConfiguration

Object

Purview Configuration

Nom	Type	Description
purviewResourceId	string	ID de ressource Purview

ResourceIdentityType

Énumération

Type d’identité managée pour l’espace de travail

Valeur	Description
None
SystemAssigned

VirtualNetworkProfile

Object

Profil de réseau virtuel

Nom	Type	Description
computeSubnetId	string	ID de sous-réseau utilisé pour les calculs dans l’espace de travail

Workspace

Object

Un espace de travail

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedIdentity	Identité de l’espace de travail
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.adlaResourceId	string	ID de ressource ADLA.
properties.connectivityEndpoints	object	Points de terminaison de connectivité
properties.defaultDataLakeStorage	DataLakeStorageAccountDetails	Détails du compte de stockage data lake par défaut de l’espace de travail
properties.encryption	EncryptionDetails	Détails du chiffrement de l’espace de travail
properties.extraProperties	object	Configurations au niveau de l’espace de travail et indicateurs de fonctionnalité
properties.managedResourceGroupName	string	Groupe de ressources géré par l’espace de travail. Le nom du groupe de ressources identifie de façon unique le groupe de ressources dans l’ID d’abonnement utilisateur. Le nom du groupe de ressources ne doit pas dépasser 90 caractères et doit être des caractères alphanumériques (Char.IsLetterOrDigit()) et '-', '_', '(', ')' et'.'. Notez que le nom ne peut pas se terminer par « . »
properties.managedVirtualNetwork	string	La définition de ce paramètre sur « par défaut » garantit que tout le calcul de cet espace de travail se trouve dans un réseau virtuel géré pour le compte de l’utilisateur.
properties.managedVirtualNetworkSettings	ManagedVirtualNetworkSettings	Paramètres de réseau virtuel managé
properties.privateEndpointConnections	PrivateEndpointConnection[]	Connexions de point de terminaison privé à l’espace de travail
properties.provisioningState	string	État d’approvisionnement des ressources
properties.purviewConfiguration	PurviewConfiguration	Purview Configuration
properties.sqlAdministratorLogin	string	Connexion pour l’administrateur SQL Active Directory de l’espace de travail
properties.sqlAdministratorLoginPassword	string	Mot de passe de connexion administrateur SQL
properties.virtualNetworkProfile	VirtualNetworkProfile	Profil de réseau virtuel
properties.workspaceRepositoryConfiguration	WorkspaceRepositoryConfiguration	Paramètres d’intégration Git
properties.workspaceUID	string (uuid)	Identificateur unique de l’espace de travail
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

WorkspaceKeyDetails

Object

Détails de la clé gérée par le client associée à l’espace de travail

Nom	Type	Description
keyVaultUrl	string	URL du coffre de clés de sous-ressource de la clé d’espace de travail
name	string	Nom de la sous-ressource clé de l’espace de travail

WorkspaceRepositoryConfiguration

Object

Paramètres d’intégration Git

Nom	Type	Description
accountName	string	Nom de compte
clientId	string	GitHub apportez votre propre ID client d’application
clientSecret	GitHubClientSecret	GitHub apporte vos propres informations de clé secrète client d’application.
collaborationBranch	string	Branche de collaboration
hostName	string	Nom d’hôte GitHub Enterprise. Par exemple : `https://github.mydomain.com`
lastCommitId	string	Dernier ID de validation
projectName	string	Nom du projet VSTS
repositoryName	string	Nom du référentiel
rootFolder	string	Dossier racine à utiliser dans le référentiel
tenantId	string (uuid)	ID de locataire VSTS
type	string	Type de configuration repositoryID de l’espace de travail. Exemple WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration

Partager via

Workspace - Get

Paramètres URI

Réponses

Exemples

Get Workspace Information

Exemple de requête

Exemple de réponse

Définitions

CustomerManagedKeyDetails

DataLakeStorageAccountDetails

EncryptionDetails

ErrorAdditionalInfo

ErrorContract

ErrorResponse

GitHubClientSecret

ManagedIdentity

ManagedVirtualNetworkSettings

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkServiceConnectionState

PurviewConfiguration

ResourceIdentityType

VirtualNetworkProfile

Workspace

WorkspaceKeyDetails

WorkspaceRepositoryConfiguration