Workspaces - Get Workspace

Tjeneste:: Admin

API-version:: v1

Returnerer det angivne arbejdsområde.

Note

Denne API er en del af en prøveversion og leveres kun til evaluerings- og udviklingsformål. Det kan ændre sig baseret på feedback og anbefales ikke til produktionsbrug.

Permissions

Den, der ringer op, skal være Fabric-administrator eller godkende ved hjælp af en tjenesteprincipal.

Påkrævede delegerede områder

Tenant.Read.All eller Tenant.ReadWrite.All

Limitations

Maksimalt 200 anmodninger pr. time.

Microsoft Entra-understøttede identiteter

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

Identity	Support
User	Yes
tjenesteprincipal og administrerede identiteter	Yes

Interface

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	Workspace	OK
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: EntityNotFound – Arbejdsområde-id'et findes ikke. InsufficientPrivileges – Kalderen har ikke tilladelse til at kalde API'en.

Workspace

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:

EntityNotFound – Arbejdsområde-id'et findes ikke.
InsufficientPrivileges – Kalderen har ikke tilladelse til at kalde API'en.

Eksempler

Get workspace details by ID example

Eksempelanmodning

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48

Eksempelsvar

Statuskode:: 200

{
  "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
  "name": "test report",
  "type": "Workspace",
  "state": "Active",
  "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
  "domainId": "8badadb6-9945-4e07-8134-00e0defec00b",
  "tags": [
    {
      "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
      "displayName": "Finance"
    }
  ]
}

Definitioner

Name	Beskrivelse
Encryption	Oplysninger om kryptering af arbejdsområdet ved hjælp af en kundeadministrerede nøgle (CMK).
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
Workspace	Workspace.
WorkspaceAppliedTag	Repræsenterer en anvendt kode.
WorkspaceEncryptionStatus	CMK-krypteringsstatus for arbejdsområdet.
WorkspaceState	Arbejdsområdetilstanden. Der kan tilføjes flere arbejdsområdetilstande over tid.
WorkspaceType	En arbejdsområdetype. Der kan tilføjes flere typer arbejdsområder over tid.

Encryption

Objekt

Oplysninger om kryptering af arbejdsområdet ved hjælp af en kundeadministrerede nøgle (CMK).

Name	Type	Beskrivelse
keyIdentifier	string	Krypteringsnøgle-id'et.
previousKeyIdentifier	string	Det forrige krypteringsnøgle-id.
previousStatus	WorkspaceEncryptionStatus	Den tidligere CMK-krypteringsstatus for arbejdsområdet.
status	WorkspaceEncryptionStatus	CMK-krypteringsstatus for arbejdsområdet.

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.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
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.

Workspace

Objekt

Workspace.

Name	Type	Beskrivelse
capacityId	string (uuid)	Kapacitets-id'et for arbejdsområdet.
domainId	string (uuid)	Arbejdsområdets domæne-id.
encryption	Encryption	Krypteringsoplysningerne for arbejdsområdet.
id	string (uuid)	Arbejdsområde-id'et.
name	string	Navnet på arbejdsområdet.
state	WorkspaceState	Arbejdsområdetilstanden.
tags	WorkspaceAppliedTag[]	Liste over anvendte mærker.
type	WorkspaceType	Arbejdsområdetypen.

WorkspaceAppliedTag

Objekt

Repræsenterer en anvendt kode.

Name	Type	Beskrivelse
displayName	string	Navnet på mærket.
id	string (uuid)	Tag-id'et.

WorkspaceEncryptionStatus

Optælling

CMK-krypteringsstatus for arbejdsområdet.

Værdi	Beskrivelse
Disabled	Kryptering af arbejdsområdet er ikke aktiv.
Active	Kryptering af arbejdsområdet er aktiv, og arbejdsområdet er krypteret.
EnableInProgress	Kryptering af arbejdsområdet aktiveres.
DisableInProgress	Kryptering af arbejdsområdet deaktiveres.
Failed	Krypteringsprogrammet til arbejdsområdet mislykkedes.

WorkspaceState

Optælling

Arbejdsområdetilstanden. Der kan tilføjes flere arbejdsområdetilstande over tid.

Værdi	Beskrivelse
Active	Arbejdsområdet er aktivt. Tabte arbejdsområder vises som aktive.
Deleted	Arbejdsområdet slettes.

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.