Items - List Environments

Tjänst:: Environment

API-version:: v1

Returnerar en lista över miljöer från den angivna arbetsytan.
Det här API:et stöder sidnumrering.

Behörigheter

Anroparen måste ha en arbetsyteroll för visningsprogrammet .

Obligatoriska delegerade omfång

Workspace.Read.All eller Workspace.ReadWrite.All

Microsoft Entra identiteter som stöds

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänsthuvudnamn och hanterade identiteter	Ja

Gränssnitt

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

Med valfria parametrar:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments?recursive={recursive}&rootFolderId={rootFolderId}&continuationToken={continuationToken}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
workspaceId	path	True	string (uuid)	Arbetsytans ID.
continuationToken	query		string	En token för att hämta nästa sida med resultat.
recursive	query		boolean	Listar objekt i en mapp och dess kapslade mappar, eller bara en mapp. Sant – Alla objekt i mappen och dess kapslade mappar visas, False – Endast objekt i mappen visas. Standardvärdet är sant.
rootFolderId	query		string (uuid)	Med den här parametern kan användare filtrera objekt baserat på en specifik rotmapp. Om det inte anges används arbetsytan som rotmapp.

Svar

Name Typ Description

200 OK

Name	Typ	Description
200 OK	Environments	Begäran har slutförts.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: InvalidItemType – Ogiltig objekttyp

Environments

Begäran har slutförts.

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

InvalidItemType – Ogiltig objekttyp

Exempel

List environments in workspace example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Environment_1",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Failed",
          "targetVersion": "14ece8b5-68a1-4130-a9e7-074c04537588",
          "startTime": "2024-03-30T14:17:09.0697022Z",
          "endTime": "2024-03-30T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Failed"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      },
      "sensitivityLabel": {
        "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
      }
    },
    {
      "id": "a8a1bffa-7eea-49dc-a1d2-6281c1d031f1",
      "displayName": "Environment_2",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Success",
          "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
          "startTime": "2024-03-29T14:17:09.0697022Z",
          "endTime": "2024-03-29T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Success"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      },
      "sensitivityLabel": {
        "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
      }
    }
  ]
}

Definitioner

Name	Description
ComponentPublishInfo	Publicera information för varje komponenter i miljön.
EntireTenantPrincipal	Representerar ett klientorganisationsobjekt
Environment	Ett miljöobjekt.
EnvironmentProperties	Miljöegenskaper.
EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.
Environments	En lista över miljöer.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
GroupPrincipal	Representerar en säkerhetsgrupp.
GroupType	Gruppens typ. Ytterligare grupptyper kan läggas till över tid.
ItemTag	Representerar en tagg som tillämpas på ett objekt.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
PrincipalType	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
PublishDetails	Information om publiceringsåtgärden.
SensitivityLabel	Representerar en känslighetsetikett som tillämpas på ett objekt.
ServicePrincipalDetails	Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipal`.
ServicePrincipalPrincipal	Representerar ett Microsoft Entra tjänstens huvudnamn.
ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Representerar en profil för tjänstens huvudnamn.
SparkLibraries	Spark-bibliotek.
SparkSettings	Spark-inställningar.
UserDetails	Specifik information om användarens huvudnamn. Gäller när huvudtypen är `User`.
UserPrincipal	Representerar ett Microsoft Entra användarens huvudnamn.

ComponentPublishInfo

Objekt

Publicera information för varje komponenter i miljön.

Name	Typ	Description
sparkLibraries	SparkLibraries	Spark-bibliotek publicerar information.
sparkSettings	SparkSettings	Spark-inställningar publicerar information.

EntireTenantPrincipal

Objekt

Representerar ett klientorganisationsobjekt

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
type	string: EntireTenant	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

Environment

Objekt

Ett miljöobjekt.

Name	Typ	Description
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Objektets standardidentitet.
description	string	Objektbeskrivningen.
displayName	string	Objektets visningsnamn.
folderId	string (uuid)	Mapp-ID:t.
id	string (uuid)	Objekt-ID:t.
properties	EnvironmentProperties	Miljöegenskaperna.
sensitivityLabel	SensitivityLabel	Objektets känslighetsetikett.
tags	ItemTag[]	Lista över tillämpade taggar.
type	ItemType	Objekttypen.
workspaceId	string (uuid)	Arbetsytans ID.

EnvironmentProperties

Objekt

Miljöegenskaper.

Name	Typ	Description
publishDetails	PublishDetails	Information om miljöpubliceringsåtgärder.

EnvironmentPublishState

Uppräkning

Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

Värde	Description
Success	Miljöpublicering har slutförts.
Cancelled	Publiceringen av miljön är i avbrutet tillstånd.
Failed	Miljöpublicering är i fel tillstånd.
Cancelling	Miljöpublicering är i avbrutet tillstånd.
Running	Miljöpublicer är i körningstillstånd.
Waiting	Publiceringen av miljön är i vänteläge.

Environments

Objekt

En lista över miljöer.

Name	Typ	Description
continuationToken	string	Token för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
continuationUri	string	URI:n för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
value	Environment[]	En lista över miljöer.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

GroupDetails

Objekt

Gruppera specifik information. Gäller när huvudtypen är Group.

Name	Typ	Description
groupType	GroupType	Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

GroupPrincipal

Objekt

Representerar en säkerhetsgrupp.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
groupDetails	GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
id	string (uuid)	Huvudmannens ID.
type	string: Group	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

GroupType

Uppräkning

Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

Värde	Description
Unknown	Huvudgrupptypen är okänd.
SecurityGroup	Huvudnamn är en säkerhetsgrupp.
DistributionList	Huvudnamn är en distributionslista.

ItemTag

Objekt

Representerar en tagg som tillämpas på ett objekt.

Name	Typ	Description
displayName	string	Namnet på taggen.
id	string (uuid)	Tagg-ID:t.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Description
Dashboard	PowerBI-instrumentpanel.
Report	PowerBI-rapport.
SemanticModel	PowerBI-semantisk modell.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Ett sjöhus.
Eventhouse	Ett eventhouse.
Environment	En miljö.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
KQLDashboard	En KQL-instrumentpanel.
DataPipeline	En datapipeline.
Notebook	En notebook-fil.
SparkJobDefinition	En definition för Spark-jobb.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
Warehouse	Ett lager.
Eventstream	En händelseström.
SQLEndpoint	En SQL-slutpunkt.
MirroredWarehouse	Ett speglat lager.
MirroredDatabase	En speglad databas.
Reflex	En reflex.
GraphQLApi	Ett API för GraphQL-objekt.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Ett kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	Ett dataflöde.
ApacheAirflowJob	Ett ApacheAirflowJob.
WarehouseSnapshot	En ögonblicksbild av lagret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ett Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	En speglad azure databricks-katalog.
Map	En karta.
AnomalyDetector	En avvikelseidentifiering.
UserDataFunction	En användardatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	En Graph QuerySet.
SnowflakeDatabase	En Snowflake-databas för att lagra isbergstabeller som skapats från Snowflake-kontot.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-databas.
Ontology	En ontologi.
EventSchemaSet	En EventSchemaSet.
DataAgent	En DataAgent.
MirroredCatalog	En MirroredCatalog.

PrincipalType

Uppräkning

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

Värde	Description
User	Huvudkontot är ett Microsoft Entra användarens huvudnamn.
ServicePrincipal	Huvudnamn är ett Microsoft Entra tjänstens huvudnamn.
Group	Huvudnamn är en säkerhetsgrupp.
ServicePrincipalProfile	Huvudnamn är en profil för tjänstens huvudnamn.
EntireTenant	Huvudkontot representerar alla klientanvändare.

PublishDetails

Objekt

Information om publiceringsåtgärden.

Name	Typ	Description
componentPublishInfo	ComponentPublishInfo	Publicera information om miljökomponenten.
endTime	string (date-time)	Sluttid för publiceringsåtgärden i UTC med formatet YYYY-MM-DDTHH:mm:ss.sssSZ.
startTime	string (date-time)	Starttid för publiceringsåtgärden i UTC med formatet YYYY-MM-DDTHH:mm:ss.ssssSZ.
state	EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.
targetVersion	string (uuid)	Målverion som ska publiceras.

SensitivityLabel

Objekt

Representerar en känslighetsetikett som tillämpas på ett objekt.

Name	Typ	Description
id	string (uuid)	Känslighetsetikettens ID.

ServicePrincipalDetails

Objekt

Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipal.

Name	Typ	Description
aadAppId	string (uuid)	Tjänstens huvudnamns Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Representerar ett Microsoft Entra tjänstens huvudnamn.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
servicePrincipalDetails	ServicePrincipalDetails	Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipal`.
type	string: ServicePrincipal	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

ServicePrincipalProfileDetails

Objekt

Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipalProfile.

Name	Typ	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Tjänstens huvudnamnsprofils överordnade huvudnamn.

ServicePrincipalProfilePrincipal

Objekt

Representerar en profil för tjänstens huvudnamn.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

SparkLibraries

Objekt

Spark-bibliotek.

Name	Typ	Description
state	EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

SparkSettings

Objekt

Spark-inställningar.

Name	Typ	Description
state	EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

UserDetails

Objekt

Specifik information om användarens huvudnamn. Gäller när huvudtypen är User.

Name	Typ	Description
userPrincipalName	string	Användarens huvudnamn.

UserPrincipal

Objekt

Representerar ett Microsoft Entra användarens huvudnamn.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
type	string: User	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
userDetails	UserDetails	Specifik information om användarens huvudnamn. Gäller när huvudtypen är `User`.