Dela via


Workspaces - Get

Hämtar en arbetsyta

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True

string

minLength: 1

ID för målprenumerationen.

workspaceName
path True

string

Namnet på arbetsytan.

api-version
query True

string

minLength: 1

DEN API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

Workspace

Other Status Codes

ErrorResponse

Exempel

Get a workspace

Exempelbegäran

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

Exempelsvar

{
  "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"
  }
}

Definitioner

Name Description
CspWorkspaceAdminProperties

AAD-administratörsegenskaper för den första arbetsytan för en CSP-prenumeration

CustomerManagedKeyDetails

Information om den kundhanterade nyckel som är associerad med arbetsytan

DataLakeStorageAccountDetails

Information om datasjölagringskontot som är associerat med arbetsytan

EncryptionDetails

Information om krypteringen som är associerad med arbetsytan

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

KekIdentityProperties

Nyckelkrypteringsnyckelegenskaper

ManagedIdentity

Arbetsytans hanterade identitet

ManagedVirtualNetworkSettings

Inställningar för hanterat virtuellt nätverk

PrivateEndpoint

Information om privat slutpunkt

PrivateEndpointConnection

En privat slutpunktsanslutning

PrivateLinkServiceConnectionState

Information om anslutningstillstånd för den privata slutpunkten

PurviewConfiguration

Purview-konfiguration

ResourceIdentityType

Typen av hanterad identitet för arbetsytan

UserAssignedManagedIdentity

Användartilldelad hanterad identitet

VirtualNetworkProfile

Profil för virtuellt nätverk

Workspace

En arbetsyta

WorkspaceKeyDetails

Information om den kundhanterade nyckel som är associerad med arbetsytan

WorkspacePublicNetworkAccess

Aktivera eller inaktivera offentlig nätverksåtkomst till arbetsytan

WorkspaceRepositoryConfiguration

Inställningar för Git-integrering

CspWorkspaceAdminProperties

AAD-administratörsegenskaper för den första arbetsytan för en CSP-prenumeration

Name Typ Description
initialWorkspaceAdminObjectId

string

AAD-objekt-ID för inledande arbetsyteadministratör

CustomerManagedKeyDetails

Information om den kundhanterade nyckel som är associerad med arbetsytan

Name Typ Description
kekIdentity

KekIdentityProperties

Nyckelkrypteringsnyckel

key

WorkspaceKeyDetails

Nyckelobjektet för arbetsytan

status

string

Kundhanterad nyckelstatus på arbetsytan

DataLakeStorageAccountDetails

Information om datasjölagringskontot som är associerat med arbetsytan

Name Typ Description
accountUrl

string

Konto-URL

createManagedPrivateEndpoint

boolean

Skapa en hanterad privat slutpunkt till det här lagringskontot eller inte

filesystem

string

Filsystemnamn

resourceId

string

ARM-resurs-ID för det här lagringskontot

EncryptionDetails

Information om krypteringen som är associerad med arbetsytan

Name Typ Description
cmk

CustomerManagedKeyDetails

Information om kundhanterad nyckel

doubleEncryptionEnabled

boolean

Dubbel kryptering aktiverat

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

KekIdentityProperties

Nyckelkrypteringsnyckelegenskaper

Name Typ Description
useSystemAssignedIdentity

Booleskt värde som anger om systemtilldelad identitet ska användas eller inte

userAssignedIdentity

string

Resurs-ID för användartilldelad identitet

ManagedIdentity

Arbetsytans hanterade identitet

Name Typ Description
principalId

string

Huvud-ID för arbetsytans hanterade identitet

tenantId

string (uuid)

Klientorganisations-ID för arbetsytans hanterade identitet

type

ResourceIdentityType

Typen av hanterad identitet för arbetsytan

userAssignedIdentities

<string,  UserAssignedManagedIdentity>

Användartilldelade hanterade identiteter.

ManagedVirtualNetworkSettings

Inställningar för hanterat virtuellt nätverk

Name Typ Description
allowedAadTenantIdsForLinking

string[]

Tillåtna Aad-klient-ID:t för länkning

linkedAccessCheckOnTargetResource

boolean

Länkad åtkomstkontroll på målresurs

preventDataExfiltration

boolean

Förhindra dataexfiltrering

PrivateEndpoint

Information om privat slutpunkt

Name Typ Description
id

string

Resurs-ID för den privata slutpunkten.

PrivateEndpointConnection

En privat slutpunktsanslutning

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties.privateEndpoint

PrivateEndpoint

Den privata slutpunkt som anslutningen tillhör.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Anslutningstillstånd för den privata slutpunktsanslutningen.

properties.provisioningState

string

Etableringstillstånd för den privata slutpunktsanslutningen.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Information om anslutningstillstånd för den privata slutpunkten

Name Typ Description
actionsRequired

string

De åtgärder som krävs för privat länktjänstanslutning.

description

string

Beskrivning av tjänstanslutningen för privat länk.

status

string

Anslutningsstatus för tjänsten private link.

PurviewConfiguration

Purview-konfiguration

Name Typ Description
purviewResourceId

string

Purview-resurs-ID

ResourceIdentityType

Typen av hanterad identitet för arbetsytan

Värde Description
None
SystemAssigned
SystemAssigned,UserAssigned

UserAssignedManagedIdentity

Användartilldelad hanterad identitet

Name Typ Description
clientId

string (uuid)

Klient-ID:t.

principalId

string (uuid)

Huvud-ID:t.

VirtualNetworkProfile

Profil för virtuellt nätverk

Name Typ Description
computeSubnetId

string

Undernäts-ID som används för beräkningar på arbetsytan

Workspace

En arbetsyta

Name Typ Standardvärde Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedIdentity

Arbetsytans identitet

location

string

Den geo-plats där resursen finns

name

string

Namnet på resursen

properties.adlaResourceId

string

ADLA-resurs-ID.

properties.azureADOnlyAuthentication

boolean

Aktivera eller inaktivera AzureADOnlyAuthentication på underresursen Alla arbetsytor

properties.connectivityEndpoints

object

Anslutningsslutpunkter

properties.cspWorkspaceAdminProperties

CspWorkspaceAdminProperties

AAD-administratörsegenskaper för den första arbetsytan för en CSP-prenumeration

properties.defaultDataLakeStorage

DataLakeStorageAccountDetails

Standardinformation om lagringskontot för arbetsytan

properties.encryption

EncryptionDetails

Krypteringsinformationen för arbetsytan

properties.extraProperties

object

Konfigurationer på arbetsytenivå och funktionsflaggor

properties.managedResourceGroupName

string

Arbetsytans hanterade resursgrupp. Resursgruppens namn identifierar resursgruppen unikt i användarprenumerations-ID:et. Resursgruppens namn får inte vara längre än 90 tecken långt och måste vara alfanumeriska tecken (Char.IsLetterOrDigit()) och "-", '_', '(', ')' och'.'. Observera att namnet inte kan sluta med '.'

properties.managedVirtualNetwork

string

Om du anger "standard" ser du till att all beräkning för den här arbetsytan finns i ett virtuellt nätverk som hanteras för användarens räkning.

properties.managedVirtualNetworkSettings

ManagedVirtualNetworkSettings

Inställningar för hanterat virtuellt nätverk

properties.privateEndpointConnections

PrivateEndpointConnection[]

Privata slutpunktsanslutningar till arbetsytan

properties.provisioningState

string

Resursetableringstillstånd

properties.publicNetworkAccess

WorkspacePublicNetworkAccess

Enabled

Aktivera eller inaktivera offentlig nätverksåtkomst till arbetsytan

properties.purviewConfiguration

PurviewConfiguration

Purview-konfiguration

properties.settings

object

Inställningar för arbetsyta

properties.sqlAdministratorLogin

string

Logga in för sql active directory-administratör för arbetsytan

properties.sqlAdministratorLoginPassword

string

Inloggningslösenord för SQL-administratör

properties.trustedServiceBypassEnabled

boolean

False

Är trustedServiceBypassEnabled för arbetsytan

properties.virtualNetworkProfile

VirtualNetworkProfile

Profil för virtuellt nätverk

properties.workspaceRepositoryConfiguration

WorkspaceRepositoryConfiguration

Inställningar för Git-integrering

properties.workspaceUID

string (uuid)

Den unika identifieraren för arbetsytan

tags

object

Resurstaggar.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

WorkspaceKeyDetails

Information om den kundhanterade nyckel som är associerad med arbetsytan

Name Typ Description
keyVaultUrl

string

Url för nyckel för arbetsytans nyckel under resurs

name

string

Namn på underresurs för arbetsytans nyckel

WorkspacePublicNetworkAccess

Aktivera eller inaktivera offentlig nätverksåtkomst till arbetsytan

Värde Description
Enabled
Disabled

WorkspaceRepositoryConfiguration

Inställningar för Git-integrering

Name Typ Description
accountName

string

Kontonamn

collaborationBranch

string

Samarbetsgren

hostName

string

GitHub Enterprise-värdnamn. Till exempel: https://github.mydomain.com

lastCommitId

string

Det senaste inchecknings-ID:t

projectName

string

VSTS-projektnamn

repositoryName

string

Namn på lagringsplats

rootFolder

string

Rotmapp som ska användas på lagringsplatsen

tenantId

string (uuid)

VSTS-klientorganisations-ID:t

type

string

Typ av konfiguration av lagringsplats-ID för arbetsytan. Exempel på WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration