Workspaces - Get Workspace

Tjeneste:: Core

API-version:: v1

Returnerer de angivne oplysninger om arbejdsområdet.

Permissions

Den, der ringer op, skal have seer eller en højere rolle i arbejdsområdet.

Påkrævede delegerede områder

Workspace.Read.All eller Workspace.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identity	Støtte
User	Yes
tjenesteprincipal og administrerede identiteter	Yes

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}

Med valgfrie parametre:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}?preferWorkspaceSpecificEndpoints={preferWorkspaceSpecificEndpoints}

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
preferWorkspaceSpecificEndpoints	query		boolean	En indstilling, der styrer, om arbejdsområdespecifikke eller generelle offentlige slutpunkter for API- og OneLake-adgang skal medtages. Sand – Medtag arbejdsområdespecifikke slutpunkter for API- og OneLake-adgang, Falsk – Medtag generelle offentlige slutpunkter for OneLake-adgang.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	WorkspaceInfo	Anmodningen blev fuldført.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: UnknownError – Der opstod en fejl.

WorkspaceInfo

Anmodningen blev fuldført.

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

UnknownError – Der opstod en fejl.

Eksempler

Get a workspace example

Get a workspace with preferWorkspaceSpecificEndpoints example

Get a workspace example

Eksempelanmodning

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227

Eksempelsvar

Statuskode:: 200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "domainId": "9ce364e0-8e9d-4605-887a-b599b3e8b123",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://eastus-onelake.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://eastus-onelake.dfs.fabric.microsoft.com"
  }
}

Get a workspace with preferWorkspaceSpecificEndpoints example

Eksempelanmodning

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227?preferWorkspaceSpecificEndpoints=True

Eksempelsvar

Statuskode:: 200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.dfs.fabric.microsoft.com"
  },
  "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
}

Definitioner

Name	Beskrivelse
CapacityAssignmentProgress	En arbejdsområdetildeling til statusstatus for kapacitet. Der kan tilføjes yderligere værdier for status for kapacitetstildeling over tid.
CapacityRegion	Området for den kapacitet, der er knyttet til dette arbejdsområde. Der kan tilføjes yderligere værdier for kapacitetsområde over tid.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
OneLakeEndpoints	De OneLake API-slutpunkter, der er knyttet til dette arbejdsområde.
WorkspaceIdentity	Et identitetsobjekt for arbejdsområdet.
WorkspaceInfo	Et arbejdsområdeobjekt.
WorkspaceType	En arbejdsområdetype. Der kan tilføjes flere typer arbejdsområder over tid.

CapacityAssignmentProgress

Optælling

En arbejdsområdetildeling til statusstatus for kapacitet. Der kan tilføjes yderligere værdier for status for kapacitetstildeling over tid.

Værdi	Beskrivelse
Completed	Den seneste kapacitetstildelingshandling blev fuldført.
Failed	Der opstod en fejl eller fejl i kapacitetstildelingshandlingen, og den kunne ikke fuldføres.
InProgress	Kapacitetstildelingshandlingen kører i øjeblikket og er endnu ikke fuldført.

CapacityRegion

Optælling

Området for den kapacitet, der er knyttet til dette arbejdsområde. Der kan tilføjes yderligere værdier for kapacitetsområde over tid.

Værdi	Beskrivelse
Australia East	Det østlige Australien
Australia Southeast	Det sydøstlige Australien
Brazil South	Det sydlige Brasilien
Brazil Southeast	Det sydøstlige Brasilien
Canada Central	Det centrale Canada-område
Canada East	Det østlige Canada-område
Central India	Området Centralindien
Central US	Det centrale USA-område
Central US EUAP	Det centrale US EUAP-område
East Asia	Området Østasien
East US	Område i det østlige USA
East US 2	Det østlige USA 2-område
France Central	Det centrale Frankrig
France South	Det sydlige Frankrig
Germany Central	Det centrale Tyskland
Germany Northeast	Det nordøstlige Tyskland
Israel Central	Det centrale Israel-område
Italy North	Norditalien
Japan East	Det østlige Japan-område
Japan West	Det vestlige Japan-område
Korea Central	Det centrale Korea
Korea South	Sydkoreas område
Mexico Central	Det centrale Mexico-område
North Central US	Det nordcentrale USA-område
North Europe	North Europe-området
Norway East	Det østlige Norge
Norway West	Det vestlige Norge-område
Poland Central	Det centrale Polen
South Africa North	Nordafrika
South Africa West	Det vestlige Afrika
South Central US	Det sydcentrale USA-område
South India	Det sydindiske område
Southeast Asia	Det sydøstlige Asien
Spain Central	Det centrale Spanien
Sweden Central	Det centrale Sverige
Switzerland North	Det nordlige Schweiz
Switzerland West	Det vestlige Schweiz
West Europe	Område i Det vestlige Europa
West India	Området Vestindien
West US	Det vestlige USA-område
West US 2	Det vestlige USA 2-område
West US 3	Det vestlige USA 3-område
West Central US	Det vestlige centrale USA-område
UAE Central	Det centrale UAE-område
UAE North	Nordområde for De Forenede Arabiske Emirater
Qatar Central	Det centrale Qatar-område
Germany West Central	Det vestlige centrale Tyskland
Germany North	Det nordlige Tyskland
UK South	Det sydlige Storbritannien
UK West	Det vestlige Storbritannien
China North	Det nordlige Kina
China East	Det østlige Kina
China East 2	Det østlige Kina 2-område
China East 3	Det østlige Kina 3-område
China North 2	Det nordlige Kina 2-område
China North 3	Det nordlige Kina 3-område

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

OneLakeEndpoints

Objekt

De OneLake API-slutpunkter, der er knyttet til dette arbejdsområde.

Name	Type	Beskrivelse
blobEndpoint	string	OneLake API-slutpunktet, der er tilgængeligt for Blob API-handlinger. Dette er som standard et områdespecifikt slutpunkt. Hvis brugeren aktiverer preferWorkspaceSpecificEndpoints, eller arbejdsområdet har offentlig adgang deaktiveret, leveres det arbejdsområdespecifikke slutpunkt for at give adgang via private links.
dfsEndpoint	string	OneLake API-slutpunktet, der er tilgængeligt for DFS- (Distributed File System) eller ADLSgen2-filsystem-API-handlinger. Dette er som standard et områdespecifikt slutpunkt. Hvis brugeren aktiverer preferWorkspaceSpecificEndpoints, eller arbejdsområdet har offentlig adgang deaktiveret, leveres det arbejdsområdespecifikke slutpunkt for at give adgang via private links.

WorkspaceIdentity

Objekt

Et identitetsobjekt for arbejdsområdet.

Name	Type	Beskrivelse
applicationId	string (uuid)	Program-id'et.
servicePrincipalId	string (uuid)	Tjenesteprincipalens id.

WorkspaceInfo

Objekt

Et arbejdsområdeobjekt.

Name	Type	Beskrivelse
apiEndpoint	string (uri)	HTTP URL-adresse, der repræsenterer det API-slutpunkt, der er specifikt for arbejdsområdet. Denne slutpunktsværdi returneres, når brugeren aktiverer preferWorkspaceSpecificEndpoints. Det giver API-adgang via private links.
capacityAssignmentProgress	CapacityAssignmentProgress	Status for status for arbejdsområdets status for kapacitetstildeling.
capacityId	string (uuid)	Id'et for den kapacitet, arbejdsområdet er tildelt til.
capacityRegion	CapacityRegion	Området for den kapacitet, der er knyttet til dette arbejdsområde.
description	string	Beskrivelsen af arbejdsområdet.
displayName	string	Det viste navn på arbejdsområdet.
domainId	string (uuid)	Id'et for det domæne, arbejdsområdet er tildelt til.
id	string (uuid)	Arbejdsområde-id'et.
oneLakeEndpoints	OneLakeEndpoints	De OneLake API-slutpunkter, der er knyttet til dette arbejdsområde.
type	WorkspaceType	Arbejdsområdetypen.
workspaceIdentity	WorkspaceIdentity	Arbejdsområdeidentiteten.

WorkspaceType

Optælling

En arbejdsområdetype. Der kan tilføjes flere typer arbejdsområder over tid.

Værdi	Beskrivelse
Personal	Min mappe eller Mit arbejdsområde, der bruges til at administrere brugerelementer.
Workspace	Arbejdsområde, der bruges til at administrere Fabric-elementerne.
AdminWorkspace	Administrationsovervågningsarbejdsområde. Indeholder administratorrapporter, f.eks. overvågningsrapporten og forbrugs- og indføringsrapporten.

Del via

Workspaces - Get Workspace

Permissions

Påkrævede delegerede områder

Microsoft Entra-understøttede identiteter

Interface

URI-parametre

Svar

Eksempler

Get a workspace example

Eksempelanmodning

Eksempelsvar

Get a workspace with preferWorkspaceSpecificEndpoints example

Eksempelanmodning

Eksempelsvar

Definitioner

CapacityAssignmentProgress

CapacityRegion

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

OneLakeEndpoints

WorkspaceIdentity

WorkspaceInfo

WorkspaceType