Workspaces - Get
Çalışma alanı alır
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}?api-version=2021-06-01
URI Parametreleri
| Name | İçinde | Gerekli | Tür | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız. |
|
subscription
|
path | True |
string minLength: 1 |
Hedef aboneliğin kimliği. |
|
workspace
|
path | True |
string |
Çalışma alanının adı. |
|
api-version
|
query | True |
string minLength: 1 |
Bu işlem için kullanılacak API sürümü. |
Yanıtlar
| Name | Tür | Description |
|---|---|---|
| 200 OK | ||
| Other Status Codes |
Örnekler
Get a workspace
Örnek isteği
Örnek yanıt
{
"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"
}
}
Tanımlar
| Name | Description |
|---|---|
|
Csp |
CSP aboneliği için ilk çalışma alanı AAD yönetici özellikleri |
|
Customer |
Çalışma alanıyla ilişkili müşteri tarafından yönetilen anahtarın ayrıntıları |
|
Data |
Çalışma alanıyla ilişkili data lake storage hesabının ayrıntıları |
|
Encryption |
Çalışma alanıyla ilişkili şifrelemenin ayrıntıları |
|
Error |
Kaynak yönetimi hatası ek bilgileri. |
|
Error |
Hata ayrıntısı. |
|
Error |
Hata yanıtı |
|
Kek |
Anahtar şifreleme anahtarı özellikleri |
|
Managed |
Çalışma alanı yönetilen kimliği |
|
Managed |
Yönetilen Sanal Ağ Ayarları |
|
Private |
Özel uç nokta ayrıntıları |
|
Private |
Özel uç nokta bağlantısı |
|
Private |
Özel uç noktanın bağlantı durumu ayrıntıları |
|
Purview |
Purview Yapılandırması |
|
Resource |
Çalışma alanı için yönetilen kimliğin türü |
|
User |
Kullanıcı Tarafından Atanan Yönetilen Kimlik |
|
Virtual |
Sanal Ağ Profili |
| Workspace |
Çalışma alanı |
|
Workspace |
Çalışma alanıyla ilişkili müşteri tarafından yönetilen anahtarın ayrıntıları |
|
Workspace |
Çalışma alanına genel ağ erişimini etkinleştirme veya devre dışı bırakma |
|
Workspace |
Git tümleştirme ayarları |
CspWorkspaceAdminProperties
CSP aboneliği için ilk çalışma alanı AAD yönetici özellikleri
| Name | Tür | Description |
|---|---|---|
| initialWorkspaceAdminObjectId |
string |
İlk çalışma alanı yöneticisinin AAD nesne kimliği |
CustomerManagedKeyDetails
Çalışma alanıyla ilişkili müşteri tarafından yönetilen anahtarın ayrıntıları
| Name | Tür | Description |
|---|---|---|
| kekIdentity |
Anahtar şifreleme anahtarı |
|
| key |
Çalışma alanının anahtar nesnesi |
|
| status |
string |
Çalışma alanında müşteri tarafından yönetilen anahtar durumu |
DataLakeStorageAccountDetails
Çalışma alanıyla ilişkili data lake storage hesabının ayrıntıları
| Name | Tür | Description |
|---|---|---|
| accountUrl |
string |
Hesap URL'si |
| createManagedPrivateEndpoint |
boolean |
Bu depolama hesabına yönetilen özel uç nokta oluştur veya oluşturma |
| filesystem |
string |
Dosya sistemi adı |
| resourceId |
string |
Bu depolama hesabının ARM kaynak kimliği |
EncryptionDetails
Çalışma alanıyla ilişkili şifrelemenin ayrıntıları
| Name | Tür | Description |
|---|---|---|
| cmk |
Müşteri Tarafından Yönetilen Anahtar Ayrıntıları |
|
| doubleEncryptionEnabled |
boolean |
Çift Şifreleme etkin |
ErrorAdditionalInfo
Kaynak yönetimi hatası ek bilgileri.
| Name | Tür | Description |
|---|---|---|
| info |
object |
Ek bilgiler. |
| type |
string |
Ek bilgi türü. |
ErrorDetail
Hata ayrıntısı.
| Name | Tür | Description |
|---|---|---|
| additionalInfo |
Hata ek bilgileri. |
|
| code |
string |
Hata kodu. |
| details |
Hata ayrıntıları. |
|
| message |
string |
Hata iletisi. |
| target |
string |
Hata hedefi. |
ErrorResponse
Hata yanıtı
| Name | Tür | Description |
|---|---|---|
| error |
Hata nesnesi. |
KekIdentityProperties
Anahtar şifreleme anahtarı özellikleri
| Name | Tür | Description |
|---|---|---|
| useSystemAssignedIdentity |
Sistem tarafından atanan kimliğin kullanılıp kullanılmayacağını belirten Boole değeri |
|
| userAssignedIdentity |
string |
Kullanıcı tarafından atanan kimlik kaynağı kimliği |
ManagedIdentity
Çalışma alanı yönetilen kimliği
| Name | Tür | Description |
|---|---|---|
| principalId |
string |
Çalışma alanı yönetilen kimliğinin asıl kimliği |
| tenantId |
string (uuid) |
Çalışma alanı yönetilen kimliğinin kiracı kimliği |
| type |
Çalışma alanı için yönetilen kimliğin türü |
|
| userAssignedIdentities |
<string,
User |
Kullanıcı tarafından yönetilen kimlikler atanır. |
ManagedVirtualNetworkSettings
Yönetilen Sanal Ağ Ayarları
| Name | Tür | Description |
|---|---|---|
| allowedAadTenantIdsForLinking |
string[] |
Bağlantı için İzin Verilen Aad Kiracı Kimlikleri |
| linkedAccessCheckOnTargetResource |
boolean |
Hedef Kaynakta Bağlı Erişim Denetimi |
| preventDataExfiltration |
boolean |
Veri Sızdırmayı Engelle |
PrivateEndpoint
Özel uç nokta ayrıntıları
| Name | Tür | Description |
|---|---|---|
| id |
string |
Özel uç noktanın kaynak kimliği. |
PrivateEndpointConnection
Özel uç nokta bağlantısı
| Name | Tür | Description |
|---|---|---|
| id |
string |
Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
Kaynağın adı |
| properties.privateEndpoint |
Bağlantının ait olduğu özel uç nokta. |
|
| properties.privateLinkServiceConnectionState |
Özel uç nokta bağlantısının bağlantı durumu. |
|
| properties.provisioningState |
string |
Özel uç nokta bağlantısının sağlama durumu. |
| type |
string |
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" |
PrivateLinkServiceConnectionState
Özel uç noktanın bağlantı durumu ayrıntıları
| Name | Tür | Description |
|---|---|---|
| actionsRequired |
string |
Özel bağlantı hizmeti bağlantısı için gereken eylemler. |
| description |
string |
Özel bağlantı hizmeti bağlantı açıklaması. |
| status |
string |
Özel bağlantı hizmeti bağlantı durumu. |
PurviewConfiguration
Purview Yapılandırması
| Name | Tür | Description |
|---|---|---|
| purviewResourceId |
string |
Purview Kaynak Kimliği |
ResourceIdentityType
Çalışma alanı için yönetilen kimliğin türü
| Değer | Description |
|---|---|
| None | |
| SystemAssigned | |
| SystemAssigned,UserAssigned |
UserAssignedManagedIdentity
Kullanıcı Tarafından Atanan Yönetilen Kimlik
| Name | Tür | Description |
|---|---|---|
| clientId |
string (uuid) |
İstemci kimliği. |
| principalId |
string (uuid) |
Asıl kimlik. |
VirtualNetworkProfile
Sanal Ağ Profili
| Name | Tür | Description |
|---|---|---|
| computeSubnetId |
string |
Çalışma alanında işlem için kullanılan alt ağ kimliği |
Workspace
Çalışma alanı
| Name | Tür | Default value | Description |
|---|---|---|---|
| id |
string |
Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
| identity |
Çalışma alanının kimliği |
||
| location |
string |
Kaynağın bulunduğu coğrafi konum |
|
| name |
string |
Kaynağın adı |
|
| properties.adlaResourceId |
string |
ADLA kaynak kimliği. |
|
| properties.azureADOnlyAuthentication |
boolean |
Tüm Çalışma Alanı alt kaynağında AzureADOnlyAuthentication'ı etkinleştirme veya devre dışı bırakma |
|
| properties.connectivityEndpoints |
object |
Bağlantı uç noktaları |
|
| properties.cspWorkspaceAdminProperties |
CSP aboneliği için ilk çalışma alanı AAD yönetici özellikleri |
||
| properties.defaultDataLakeStorage |
Çalışma alanı varsayılan data lake storage hesabı ayrıntıları |
||
| properties.encryption |
Çalışma alanının şifreleme ayrıntıları |
||
| properties.extraProperties |
object |
Çalışma alanı düzeyi yapılandırmaları ve özellik bayrakları |
|
| properties.managedResourceGroupName |
string |
Çalışma alanı yönetilen kaynak grubu. Kaynak grubu adı, user subscriptionId içindeki kaynak grubunu benzersiz olarak tanımlar. Kaynak grubu adı 90 karakterden uzun olmamalıdır ve alfasayısal karakterler (Char.IsLetterOrDigit()) ve '-', '_', '(', ')' ve'.' olmalıdır. Adın '.' ile bitemeyeceğini unutmayın. |
|
| properties.managedVirtualNetwork |
string |
Bunu 'varsayılan' olarak ayarlamak, bu çalışma alanının tüm işleminin kullanıcı adına yönetilen bir sanal ağda olmasını sağlar. |
|
| properties.managedVirtualNetworkSettings |
Yönetilen Sanal Ağ Ayarları |
||
| properties.privateEndpointConnections |
Çalışma alanına özel uç nokta bağlantıları |
||
| properties.provisioningState |
string |
Kaynak sağlama durumu |
|
| properties.publicNetworkAccess | Enabled |
Çalışma alanına genel ağ erişimini etkinleştirme veya devre dışı bırakma |
|
| properties.purviewConfiguration |
Purview Yapılandırması |
||
| properties.settings |
object |
Çalışma alanı ayarları |
|
| properties.sqlAdministratorLogin |
string |
Çalışma alanı SQL active directory yöneticisi için oturum açma |
|
| properties.sqlAdministratorLoginPassword |
string |
SQL yöneticisi oturum açma parolası |
|
| properties.trustedServiceBypassEnabled |
boolean |
False |
Çalışma alanı için trustedServiceBypassEnabled |
| properties.virtualNetworkProfile |
Sanal Ağ profili |
||
| properties.workspaceRepositoryConfiguration |
Git tümleştirme ayarları |
||
| properties.workspaceUID |
string (uuid) |
Çalışma alanı benzersiz tanımlayıcısı |
|
| tags |
object |
Kaynak etiketleri. |
|
| type |
string |
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" |
WorkspaceKeyDetails
Çalışma alanıyla ilişkili müşteri tarafından yönetilen anahtarın ayrıntıları
| Name | Tür | Description |
|---|---|---|
| keyVaultUrl |
string |
Çalışma Alanı Anahtarı alt kaynak anahtar kasası URL'si |
| name |
string |
Çalışma Alanı Anahtarı alt kaynak adı |
WorkspacePublicNetworkAccess
Çalışma alanına genel ağ erişimini etkinleştirme veya devre dışı bırakma
| Değer | Description |
|---|---|
| Enabled | |
| Disabled |
WorkspaceRepositoryConfiguration
Git tümleştirme ayarları
| Name | Tür | Description |
|---|---|---|
| accountName |
string |
Hesap adı |
| collaborationBranch |
string |
İşbirliği dalı |
| hostName |
string |
GitHub Enterprise ana bilgisayar adı. Örneğin: |
| lastCommitId |
string |
Son işleme kimliği |
| projectName |
string |
VSTS proje adı |
| repositoryName |
string |
Depo adı |
| rootFolder |
string |
Depoda kullanılacak kök klasör |
| tenantId |
string (uuid) |
VSTS kiracı kimliği |
| type |
string |
Çalışma alanı depo kimliği yapılandırmasının türü. Örnek WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration |