Workspace - Get

Szolgáltatás:: Synapse

API-verzió:: 2020-12-01

Munkaterület lekérése

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A munkaterület fejlesztési végpontja, például `https://myworkspace.dev.azuresynapse.net`.
api-version	query	True	string	A Synapse ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	Workspace	Sikeres válasz.
Other Status Codes	ErrorContract	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Példák

Get Workspace Information

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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"
  }
}

Állapotkód:: default

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

Definíciók

Name	Description
CustomerManagedKeyDetails	A munkaterülethez társított ügyfél által kezelt kulcs részletei
DataLakeStorageAccountDetails	A munkaterülethez társított Data Lake Storage-fiók adatai
EncryptionDetails	A munkaterülethez társított titkosítás részletei
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorContract	Hiba részletei.
ErrorResponse	Hibaválasz
GitHubClientSecret	Az ügyfél titkos információi a gyár saját alkalmazásadattár-konfigurációjához
ManagedIdentity	A munkaterület felügyelt identitása
ManagedVirtualNetworkSettings	Felügyelt virtuális hálózati beállítások
PrivateEndpoint	Privát végpont részletei
PrivateEndpointConnection	Privát végpontkapcsolat
PrivateLinkServiceConnectionState	A privát végpont kapcsolatállapotának részletei
PurviewConfiguration	Purview-konfiguráció
ResourceIdentityType	A munkaterület felügyelt identitásának típusa
VirtualNetworkProfile	Virtuális hálózati profil
Workspace	Munkaterület
WorkspaceKeyDetails	A munkaterülethez társított ügyfél által kezelt kulcs részletei
WorkspaceRepositoryConfiguration	Git-integrációs beállítások

CustomerManagedKeyDetails

Objektum

A munkaterülethez társított ügyfél által kezelt kulcs részletei

Name	Típus	Description
key	WorkspaceKeyDetails	A munkaterület kulcsobjektuma
status	string	Az ügyfél által felügyelt kulcs állapota a munkaterületen

DataLakeStorageAccountDetails

Objektum

A munkaterülethez társított Data Lake Storage-fiók adatai

Name	Típus	Description
accountUrl	string	Fiók URL-címe
filesystem	string	Fájlrendszer neve

EncryptionDetails

Objektum

A munkaterülethez társított titkosítás részletei

Name	Típus	Description
cmk	CustomerManagedKeyDetails	Ügyfél által kezelt kulcs részletei
doubleEncryptionEnabled	boolean	Dupla titkosítás engedélyezve

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorContract

Objektum

Hiba részletei.

Name	Típus	Description
error	ErrorResponse	Hibaválasz A hiba részletei.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

GitHubClientSecret

Objektum

Az ügyfél titkos információi a gyár saját alkalmazásadattár-konfigurációjához

Name	Típus	Description
byoaSecretAkvUrl	string	Saját alkalmazásügyfél titkos AKV URL-címének használata
byoaSecretName	string	Saját alkalmazásügyfél titkos kódnevének megadása az AKV-ban

ManagedIdentity

Objektum

A munkaterület felügyelt identitása

Name	Típus	Description
principalId	string	A munkaterület felügyelt identitásának egyszerű azonosítója
tenantId	string (uuid)	A munkaterület felügyelt identitásának bérlőazonosítója
type	ResourceIdentityType	A munkaterület felügyelt identitásának típusa

ManagedVirtualNetworkSettings

Objektum

Felügyelt virtuális hálózati beállítások

Name	Típus	Description
allowedAadTenantIdsForLinking	string[]	Engedélyezett Aad-bérlőazonosítók csatoláshoz
linkedAccessCheckOnTargetResource	boolean	Csatolt hozzáférés ellenőrzése a célerőforráson
preventDataExfiltration	boolean	Adatszűrés megakadályozása

PrivateEndpoint

Objektum

Privát végpont részletei

Name	Típus	Description
id	string	A privát végpont erőforrás-azonosítója.

PrivateEndpointConnection

Objektum

Privát végpontkapcsolat

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.privateEndpoint	PrivateEndpoint	Az a privát végpont, amelyhez a kapcsolat tartozik.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A privát végpont kapcsolati állapota.
properties.provisioningState	string	A privát végpontkapcsolat kiépítési állapota.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Objektum

A privát végpont kapcsolatállapotának részletei

Name	Típus	Description
actionsRequired	string	A privát kapcsolat szolgáltatáskapcsolatához szükséges műveletek.
description	string	A privát kapcsolat szolgáltatás kapcsolatának leírása.
status	string	A privát kapcsolat szolgáltatás kapcsolati állapota.

PurviewConfiguration

Objektum

Purview-konfiguráció

Name	Típus	Description
purviewResourceId	string	Purview-erőforrás azonosítója

ResourceIdentityType

Enumerálás

A munkaterület felügyelt identitásának típusa

Érték	Description
None
SystemAssigned

VirtualNetworkProfile

Objektum

Virtuális hálózati profil

Name	Típus	Description
computeSubnetId	string	A munkaterületen lévő számításokhoz használt alhálózat-azonosító

Workspace

Objektum

Munkaterület

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedIdentity	A munkaterület identitása
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.adlaResourceId	string	Az ADLA-erőforrás azonosítója.
properties.connectivityEndpoints	object	Csatlakozási végpontok
properties.defaultDataLakeStorage	DataLakeStorageAccountDetails	A munkaterület alapértelmezett data lake storage-fiókadatai
properties.encryption	EncryptionDetails	A munkaterület titkosítási adatai
properties.extraProperties	object	Munkaterületszintű konfigurációk és funkciójelzők
properties.managedResourceGroupName	string	Munkaterület által felügyelt erőforráscsoport. Az erőforráscsoport neve egyedileg azonosítja az erőforráscsoportot a felhasználói subscriptionId azonosítón belül. Az erőforráscsoport neve nem lehet hosszabb 90 karakternél, és alfanumerikus karaktereknek (Char.IsLetterOrDigit()) és "-", "_", "(", ")" és". Vegye figyelembe, hogy a név nem végződhet a következővel: "."
properties.managedVirtualNetwork	string	Ha ezt az alapértelmezett értéket állítja be, az biztosítja, hogy a munkaterület összes számítása a felhasználó nevében felügyelt virtuális hálózatban legyen.
properties.managedVirtualNetworkSettings	ManagedVirtualNetworkSettings	Felügyelt virtuális hálózati beállítások
properties.privateEndpointConnections	PrivateEndpointConnection[]	Privát végpontkapcsolatok a munkaterülethez
properties.provisioningState	string	Erőforrás-kiépítés állapota
properties.purviewConfiguration	PurviewConfiguration	Purview-konfiguráció
properties.sqlAdministratorLogin	string	Bejelentkezés munkaterületi SQL Active Directory-rendszergazdához
properties.sqlAdministratorLoginPassword	string	SQL-rendszergazda bejelentkezési jelszava
properties.virtualNetworkProfile	VirtualNetworkProfile	Virtuális hálózati profil
properties.workspaceRepositoryConfiguration	WorkspaceRepositoryConfiguration	Git-integrációs beállítások
properties.workspaceUID	string (uuid)	A munkaterület egyedi azonosítója
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

WorkspaceKeyDetails

Objektum

A munkaterülethez társított ügyfél által kezelt kulcs részletei

Name	Típus	Description
keyVaultUrl	string	Munkaterületkulcs alerőforráskulcs-tároló URL-címe
name	string	Munkaterületkulcs alerőforrásának neve

WorkspaceRepositoryConfiguration

Objektum

Git-integrációs beállítások

Name	Típus	Description
accountName	string	Fióknév
clientId	string	A GitHub saját alkalmazásügyfél-azonosítót hoz
clientSecret	GitHubClientSecret	A GitHub saját alkalmazásügyfél titkos adatait tartalmazza.
collaborationBranch	string	Együttműködési ág
hostName	string	GitHub Enterprise-gazdagép neve. Például: `https://github.mydomain.com`
lastCommitId	string	Az utolsó véglegesítés azonosítója
projectName	string	VSTS-projekt neve
repositoryName	string	Adattár neve
rootFolder	string	Az adattárban használandó gyökérmappa
tenantId	string (uuid)	A VSTS-bérlő azonosítója
type	string	A munkaterület adattárazonosító-konfigurációjának típusa. Példa WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration

Megosztás a következőn keresztül:

Workspace - Get

URI-paraméterek

Válaszok

Példák

Get Workspace Information

Mintakérelem

Mintaválasz

Definíciók

CustomerManagedKeyDetails

DataLakeStorageAccountDetails

EncryptionDetails

ErrorAdditionalInfo

ErrorContract

ErrorResponse

GitHubClientSecret

ManagedIdentity

ManagedVirtualNetworkSettings

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkServiceConnectionState

PurviewConfiguration

ResourceIdentityType

VirtualNetworkProfile

Workspace

WorkspaceKeyDetails

WorkspaceRepositoryConfiguration