Workspaces - Get
Munkaterület lekéri
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}?api-version=2021-06-01
URI-paraméterek
| Name | In | Kötelező | Típus | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket. |
|
subscription
|
path | True |
string minLength: 1 |
A cél-előfizetés azonosítója. |
|
workspace
|
path | True |
string |
A munkaterület neve. |
|
api-version
|
query | True |
string minLength: 1 |
A művelethez használni kívánt API-verzió. |
Válaszok
| Name | Típus | Description |
|---|---|---|
| 200 OK | ||
| Other Status Codes |
Példák
Get a workspace
Mintakérelem
Mintaválasz
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1",
"name": "workspace1",
"type": "Microsoft.Synapse/workspaces",
"location": "East US",
"properties": {
"defaultDataLakeStorage": {
"accountUrl": "https://accountname.dfs.core.windows.net",
"filesystem": "default"
},
"connectivityEndpoints": {
"dev": "workspace1.dev.projectarcadia.net",
"sql": "workspace1.sql.projectarcadia.net",
"web": "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": "resourceGroup2",
"workspaceRepositoryConfiguration": {
"type": "FactoryGitHubConfiguration",
"hostName": "",
"accountName": "myGithubAccount",
"projectName": "myProject",
"repositoryName": "myRepository",
"collaborationBranch": "master",
"rootFolder": "/",
"tenantId": "00000000-1111-2222-3333-444444444444"
},
"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",
"cspWorkspaceAdminProperties": {
"initialWorkspaceAdminObjectId": "6c20646f-8050-49ec-b3b1-80a0e58e454d"
},
"extraProperties": {
"IsScopeEnabled": "false",
"WorkspaceType": "Normal"
}
},
"tags": {
"key": "value"
}
}
{
"error": {
"code": "Error code",
"message": "Error message"
}
}
Definíciók
| Name | Description |
|---|---|
|
Csp |
Kezdeti munkaterület AAD-rendszergazdai tulajdonságai EGY CSP-előfizetéshez |
|
Customer |
A munkaterülethez társított ügyfél által kezelt kulcs részletei |
|
Data |
A munkaterülethez társított Data Lake Storage-fiók adatai |
|
Encryption |
A munkaterülethez társított titkosítás részletei |
|
Error |
Az erőforrás-kezelési hiba további információi. |
|
Error |
A hiba részletei. |
|
Error |
Hibaválasz |
|
Kek |
Kulcstitkosítási kulcs tulajdonságai |
|
Managed |
A munkaterület felügyelt identitása |
|
Managed |
Felügyelt virtuális hálózati beállítások |
|
Private |
Privát végpont részletei |
|
Private |
Privát végpontkapcsolat |
|
Private |
A privát végpont kapcsolatállapotának részletei |
|
Purview |
Purview-konfiguráció |
|
Resource |
A munkaterület felügyelt identitásának típusa |
|
User |
Felhasználó által hozzárendelt felügyelt identitás |
|
Virtual |
Virtuális hálózati profil |
| Workspace |
Munkaterület |
|
Workspace |
A munkaterülethez társított ügyfél által kezelt kulcs részletei |
|
Workspace |
Nyilvános hálózati hozzáférés engedélyezése vagy letiltása a munkaterülethez |
|
Workspace |
Git-integrációs beállítások |
CspWorkspaceAdminProperties
Kezdeti munkaterület AAD-rendszergazdai tulajdonságai EGY CSP-előfizetéshez
| Name | Típus | Description |
|---|---|---|
| initialWorkspaceAdminObjectId |
string |
A kezdeti munkaterület rendszergazdájának AAD-objektumazonosítója |
CustomerManagedKeyDetails
A munkaterülethez társított ügyfél által kezelt kulcs részletei
| Name | Típus | Description |
|---|---|---|
| kekIdentity |
Kulcstitkosítási kulcs |
|
| key |
A munkaterület kulcsobjektuma |
|
| status |
string |
Az ügyfél által felügyelt kulcs állapota a munkaterületen |
DataLakeStorageAccountDetails
A munkaterülethez társított Data Lake Storage-fiók adatai
| Name | Típus | Description |
|---|---|---|
| accountUrl |
string |
Fiók URL-címe |
| createManagedPrivateEndpoint |
boolean |
Felügyelt privát végpont létrehozása ehhez a tárfiókhoz vagy sem |
| filesystem |
string |
Fájlrendszer neve |
| resourceId |
string |
A tárfiók ARM-erőforrás-azonosítója |
EncryptionDetails
A munkaterülethez társított titkosítás részletei
| Name | Típus | Description |
|---|---|---|
| cmk |
Ügyfél által kezelt kulcs részletei |
|
| doubleEncryptionEnabled |
boolean |
Dupla titkosítás engedélyezve |
ErrorAdditionalInfo
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. |
ErrorDetail
A hiba részletei.
| Name | Típus | Description |
|---|---|---|
| additionalInfo |
A hiba további információi. |
|
| code |
string |
A hibakód. |
| details |
A hiba részletei. |
|
| message |
string |
A hibaüzenet. |
| target |
string |
A hibacél. |
ErrorResponse
Hibaválasz
| Name | Típus | Description |
|---|---|---|
| error |
A hibaobjektum. |
KekIdentityProperties
Kulcstitkosítási kulcs tulajdonságai
| Name | Típus | Description |
|---|---|---|
| useSystemAssignedIdentity |
Logikai érték, amely meghatározza, hogy a rendszer által hozzárendelt identitást használja-e vagy sem |
|
| userAssignedIdentity |
string |
Felhasználó által hozzárendelt identitáserőforrás-azonosító |
ManagedIdentity
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 |
A munkaterület felügyelt identitásának típusa |
|
| userAssignedIdentities |
<string,
User |
A felhasználó hozzárendelt felügyelt identitásokat. |
ManagedVirtualNetworkSettings
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
Privát végpont részletei
| Name | Típus | Description |
|---|---|---|
| id |
string |
A privát végpont erőforrás-azonosítója. |
PrivateEndpointConnection
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 |
Az a privát végpont, amelyhez a kapcsolat tartozik. |
|
| properties.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
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
Purview-konfiguráció
| Name | Típus | Description |
|---|---|---|
| purviewResourceId |
string |
Purview-erőforrás azonosítója |
ResourceIdentityType
A munkaterület felügyelt identitásának típusa
| Érték | Description |
|---|---|
| None | |
| SystemAssigned | |
| SystemAssigned,UserAssigned |
UserAssignedManagedIdentity
Felhasználó által hozzárendelt felügyelt identitás
| Name | Típus | Description |
|---|---|---|
| clientId |
string (uuid) |
Az ügyfél azonosítója. |
| principalId |
string (uuid) |
Az egyszerű azonosító. |
VirtualNetworkProfile
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
Munkaterület
| Name | Típus | Alapértelmezett érték | Description |
|---|---|---|---|
| id |
string |
Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
| identity |
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.azureADOnlyAuthentication |
boolean |
Az AzureADOnlyAuthentication engedélyezése vagy letiltása minden munkaterületi alforráson |
|
| properties.connectivityEndpoints |
object |
Csatlakozási végpontok |
|
| properties.cspWorkspaceAdminProperties |
Kezdeti munkaterület AAD-rendszergazdai tulajdonságai EGY CSP-előfizetéshez |
||
| properties.defaultDataLakeStorage |
A munkaterület alapértelmezett data lake storage-fiókadatai |
||
| properties.encryption |
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 |
Felügyelt virtuális hálózati beállítások |
||
| properties.privateEndpointConnections |
Privát végpontkapcsolatok a munkaterülethez |
||
| properties.provisioningState |
string |
Erőforrás-kiépítés állapota |
|
| properties.publicNetworkAccess | Enabled |
Nyilvános hálózati hozzáférés engedélyezése vagy letiltása a munkaterülethez |
|
| properties.purviewConfiguration |
Purview-konfiguráció |
||
| properties.settings |
object |
Munkaterület beállításai |
|
| properties.sqlAdministratorLogin |
string |
Bejelentkezés munkaterületi SQL Active Directory-rendszergazdához |
|
| properties.sqlAdministratorLoginPassword |
string |
SQL-rendszergazda bejelentkezési jelszava |
|
| properties.trustedServiceBypassEnabled |
boolean |
False |
MegbízhatóServiceBypassEnabled a munkaterülethez |
| properties.virtualNetworkProfile |
Virtuális hálózati profil |
||
| properties.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
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 |
WorkspacePublicNetworkAccess
Nyilvános hálózati hozzáférés engedélyezése vagy letiltása a munkaterülethez
| Érték | Description |
|---|---|
| Enabled | |
| Disabled |
WorkspaceRepositoryConfiguration
Git-integrációs beállítások
| Name | Típus | Description |
|---|---|---|
| accountName |
string |
Fióknév |
| collaborationBranch |
string |
Együttműködési ág |
| hostName |
string |
GitHub Enterprise-gazdagép neve. Például: |
| 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 |