Items - List Environments

Szolgáltatás:: Environment

API-verzió:: v1

A megadott munkaterületről származó környezetek listáját adja vissza.
Ez az API támogatja lapozási.

Engedélyek

A hívónak megtekintő munkaterületi szerepkörrel kell rendelkeznie.

Kötelező delegált hatókörök

Workspace.Read.All vagy Workspace.ReadWrite.All

Microsoft Entra támogatott identitások

Ez az API támogatja az ebben a szakaszban felsorolt Microsoft dentitásokat.

Azonosság	Támogat
Felhasználó	Igen
szolgáltatás-princípium és felügyelt identitások	Igen

Interfész

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
workspaceId	path	True	string (uuid)	A munkaterület azonosítója.
continuationToken	query		string	Jogkivonat az eredmények következő oldalának lekéréséhez.
recursive	query		boolean	Egy mappa elemeit és beágyazott mappáit listázza, vagy csak egy mappát. Igaz – A mappában és a beágyazott mappáiban minden elem szerepel, Hamis – Csak a mappában lévő elemek szerepelnek a listában. Az alapértelmezett érték igaz.
rootFolderId	query		string (uuid)	Ez a paraméter lehetővé teszi, hogy a felhasználók egy adott gyökérmappán alapuló elemeket szűrjenek. Ha nincs megadva, a munkaterület lesz a gyökérmappa.

Válaszok

Name Típus Description

200 OK

Name	Típus	Description
200 OK	Environments	A kérés sikeresen befejeződött.
429 Too Many Requests	ErrorResponse	Túllépte a szolgáltatási sebesség korlátját. A kiszolgáló egy `Retry-After` fejlécet ad vissza másodpercek alatt, amely jelzi, hogy az ügyfélnek mennyi ideig kell várnia a további kérések elküldése előtt. Fejlécek Retry-After: integer
Other Status Codes	ErrorResponse	Gyakori hibakódok: InvalidItemType – Érvénytelen elemtípus

Environments

A kérés sikeresen befejeződött.

429 Too Many Requests

ErrorResponse

Túllépte a szolgáltatási sebesség korlátját. A kiszolgáló egy Retry-After fejlécet ad vissza másodpercek alatt, amely jelzi, hogy az ügyfélnek mennyi ideig kell várnia a további kérések elküldése előtt.

Fejlécek

Retry-After: integer

Other Status Codes

ErrorResponse

Gyakori hibakódok:

InvalidItemType – Érvénytelen elemtípus

Példák

List environments in workspace example

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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"
      }
    }
  ]
}

Definíciók

Name	Description
ComponentPublishInfo	A környezet minden összetevőjének adatainak közzététele.
EntireTenantPrincipal	Bérlői tagot jelöl
Environment	Környezeti elem.
EnvironmentProperties	Környezeti tulajdonságok.
EnvironmentPublishState	Közzétételi állapot. Idővel további állapottípusok is hozzáadhatók.
Environments	A környezetek listája.
ErrorRelatedResource	A hibával kapcsolatos erőforrás-részletek objektum.
ErrorResponse	A hibaválasz.
ErrorResponseDetails	A hibaválasz részletei.
GroupDetails	Csoportosítsa a részleteket. Akkor alkalmazható, ha az egyszerű típus `Group`.
GroupPrincipal	Biztonsági csoportot jelöl.
GroupType	A csoport típusa. Idővel további csoporttípusok is hozzáadhatók.
ItemTag	Egy elemre alkalmazott címkét jelöl.
ItemType	Az elem típusa. Idővel további elemtípusok is hozzáadhatók.
PrincipalType	A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.
PublishDetails	A közzétételi művelet részletei.
SensitivityLabel	Egy elemre alkalmazott bizalmassági címkét jelöl.
ServicePrincipalDetails	A szolgáltatásnév konkrét részletei. Akkor alkalmazható, ha az egyszerű típus `ServicePrincipal`.
ServicePrincipalPrincipal	Egy Microsoft Entra szolgáltatásnevet jelöl.
ServicePrincipalProfileDetails	A szolgáltatásnév profiladatai. Akkor alkalmazható, ha az egyszerű típus `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Szolgáltatásnév-profilt jelöl.
SparkLibraries	Spark-kódtárak.
SparkSettings	Spark-beállítások.
UserDetails	A felhasználó egyszerű adatai. Akkor alkalmazható, ha az egyszerű típus `User`.
UserPrincipal	Egy Microsoft Entra felhasználónevet jelöl.

ComponentPublishInfo

Tárgy

A környezet minden összetevőjének adatainak közzététele.

Name	Típus	Description
sparkLibraries	SparkLibraries	A Spark-kódtárak információkat tesznek közzé.
sparkSettings	SparkSettings	A Spark beállításai közzéteszik az információkat.

EntireTenantPrincipal

Tárgy

Bérlői tagot jelöl

Name	Típus	Description
displayName	string	Az egyszerű megjelenítendő neve.
id	string (uuid)	Az igazgató azonosítója.
type	string: EntireTenant	A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.

Environment

Tárgy

Környezeti elem.

Name	Típus	Description
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Az elem alapértelmezett identitása.
description	string	Az elem leírása.
displayName	string	Az elem megjelenítendő neve.
folderId	string (uuid)	A mappa azonosítója.
id	string (uuid)	Az elem azonosítója.
properties	EnvironmentProperties	A környezeti tulajdonságok.
sensitivityLabel	SensitivityLabel	Az elem bizalmassági címkéje.
tags	ItemTag[]	Az alkalmazott címkék listája.
type	ItemType	Az elem típusa.
workspaceId	string (uuid)	A munkaterület azonosítója.

EnvironmentProperties

Tárgy

Környezeti tulajdonságok.

Name	Típus	Description
publishDetails	PublishDetails	A környezet közzétételi műveletének részletei.

EnvironmentPublishState

Felsorolás

Közzétételi állapot. Idővel további állapottípusok is hozzáadhatók.

Érték	Description
Success	A környezeti közzététel sikeres állapotban van.
Cancelled	A környezeti közzététel megszakított állapotban van.
Failed	A környezeti közzététel sikertelen állapotban van.
Cancelling	A környezeti közzététel visszavonási állapotban van.
Running	A környezeti közzététel futó állapotban van.
Waiting	A környezeti közzététel várakozási állapotban van.

Environments

Tárgy

A környezetek listája.

Name	Típus	Description
continuationToken	string	A következő eredményhalmaz kötegének jogkivonata. Ha nincs több rekord, az törlődik a válaszból.
continuationUri	string	A következő eredményhalmaz köteg URI-ja. Ha nincs több rekord, az törlődik a válaszból.
value	Environment[]	A környezetek listája.

ErrorRelatedResource

Tárgy

A hibával kapcsolatos erőforrás-részletek objektum.

Name	Típus	Description
resourceId	string	A hibában érintett erőforrás-azonosító.
resourceType	string	A hibában érintett erőforrás típusa.

ErrorResponse

Tárgy

A hibaválasz.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
isRetriable	boolean	Ha igaz, a kérés újrapróbálkozott. Ha elérhető, a `Retry-After` válaszfejléc használatával állapítsa meg a késést.
message	string	A hiba emberi olvasható ábrázolása.
moreDetails	ErrorResponseDetails[]	További hibaadatok listája.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.
requestId	string (uuid)	A hibához társított kérés azonosítója.

ErrorResponseDetails

Tárgy

A hibaválasz részletei.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message	string	A hiba emberi olvasható ábrázolása.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.

GroupDetails

Tárgy

Csoportosítsa a részleteket. Akkor alkalmazható, ha az egyszerű típus Group.

Name	Típus	Description
groupType	GroupType	A csoport típusa. Idővel további csoporttípusok is hozzáadhatók.

GroupPrincipal

Tárgy

Biztonsági csoportot jelöl.

Name	Típus	Description
displayName	string	Az egyszerű megjelenítendő neve.
groupDetails	GroupDetails	Csoportosítsa a részleteket. Akkor alkalmazható, ha az egyszerű típus `Group`.
id	string (uuid)	Az igazgató azonosítója.
type	string: Group	A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.

GroupType

Felsorolás

A csoport típusa. Idővel további csoporttípusok is hozzáadhatók.

Érték	Description
Unknown	Az egyszerű csoport típusa ismeretlen.
SecurityGroup	Az egyszerű egy biztonsági csoport.
DistributionList	Az egyszerű egy terjesztési lista.

ItemTag

Tárgy

Egy elemre alkalmazott címkét jelöl.

Name	Típus	Description
displayName	string	A címke neve.
id	string (uuid)	A címke azonosítója.

ItemType

Felsorolás

Az elem típusa. Idővel további elemtípusok is hozzáadhatók.

Érték	Description
Dashboard	PowerBI-irányítópult.
Report	PowerBI-jelentés.
SemanticModel	PowerBI szemantikai modell.
PaginatedReport	Többoldalas PowerBI-jelentés.
Datamart	PowerBI datamart.
Lakehouse	Egy tóház.
Eventhouse	Egy rendezvényház.
Environment	Egy környezet.
KQLDatabase	KQL-adatbázis.
KQLQueryset	KQL-lekérdezéskészlet.
KQLDashboard	KQL-irányítópult.
DataPipeline	Egy adatfolyam.
Notebook	Egy jegyzetfüzet.
SparkJobDefinition	Spark-feladat definíciója.
MLExperiment	Gépi tanulási kísérlet.
MLModel	Gépi tanulási modell.
Warehouse	Egy raktár.
Eventstream	Eseménystream.
SQLEndpoint	EGY SQL-végpont.
MirroredWarehouse	Egy tükrözött raktár.
MirroredDatabase	Tükrözött adatbázis.
Reflex	Egy reflex.
GraphQLApi	Api a GraphQL-elemhez.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Másolási feladat.
VariableLibrary	Egy VariableLibrary.
Dataflow	Adatfolyam.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Raktári pillanatkép.
DigitalTwinBuilder	Egy DigitalTwinBuilder.
DigitalTwinBuilderFlow	A Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	Tükrözött Azure Databricks-katalógus.
Map	Térkép.
AnomalyDetector	Anomáliadetektor.
UserDataFunction	Felhasználói adatfüggvény.
GraphModel	Egy GraphModel.
GraphQuerySet	Egy Graph Queryset.
SnowflakeDatabase	Snowflake-adatbázis a Snowflake-fiókból létrehozott Iceberg-táblák tárolására.
OperationsAgent	Egy OperationsAgent.
CosmosDBDatabase	Cosmos DB-adatbázis.
Ontology	Egy ontológia.
EventSchemaSet	An EventSchemaSet.
DataAgent	Egy DataAgent.
MirroredCatalog	Tükrözöttcatalog.
AppBackend	Egy AppBackend.
OrgApp	Szervezeti alkalmazás.
OrgAppAudience	Szervezeti alkalmazás célközönsége.
DataBuildToolJob	Egy DataBuildToolJob.
AzureDatabricksStorage	OneLake-alapú tárolóelem Azure Databricks.
Plan	Egy terv.

PrincipalType

Felsorolás

A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.

Érték	Description
User	A rendszernév egy Microsoft Entra felhasználónév.
ServicePrincipal	Az egyszerű szolgáltatásnév egy Microsoft Entra szolgáltatásnév.
Group	Az egyszerű egy biztonsági csoport.
ServicePrincipalProfile	Az egyszerű szolgáltatásnév egy szolgáltatásnév-profil.
EntireTenant	Az egyszerűség az összes bérlőfelhasználót jelöli.

PublishDetails

Tárgy

A közzétételi művelet részletei.

Name	Típus	Description
componentPublishInfo	ComponentPublishInfo	A környezeti összetevő közzétételi információi.
endTime	string (date-time)	A közzétételi művelet befejezési időpontja UTC-ben, YYYYY-MM-DDTHH:mm:ssssZ formátumban.
startTime	string (date-time)	A közzétételi művelet kezdési időpontja UTC-ben, YYYYY-MM-DDTHH:mm:ssssZ formátumban.
state	EnvironmentPublishState	Közzétételi állapot. Idővel további állapottípusok is hozzáadhatók.
targetVersion	string (uuid)	Közzéteendő célpont.

SensitivityLabel

Tárgy

Egy elemre alkalmazott bizalmassági címkét jelöl.

Name	Típus	Description
id	string (uuid)	A bizalmassági címke azonosítója.

ServicePrincipalDetails

Tárgy

A szolgáltatásnév konkrét részletei. Akkor alkalmazható, ha az egyszerű típus ServicePrincipal.

Name	Típus	Description
aadAppId	string (uuid)	A szolgáltatásnév Microsoft Entra AppId.

ServicePrincipalPrincipal

Tárgy

Egy Microsoft Entra szolgáltatásnevet jelöl.

Name	Típus	Description
displayName	string	Az egyszerű megjelenítendő neve.
id	string (uuid)	Az igazgató azonosítója.
servicePrincipalDetails	ServicePrincipalDetails	A szolgáltatásnév konkrét részletei. Akkor alkalmazható, ha az egyszerű típus `ServicePrincipal`.
type	string: ServicePrincipal	A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.

ServicePrincipalProfileDetails

Tárgy

A szolgáltatásnév profiladatai. Akkor alkalmazható, ha az egyszerű típus ServicePrincipalProfile.

Name	Típus	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	A szolgáltatásnév-profil szülőnevét.

ServicePrincipalProfilePrincipal

Tárgy

Szolgáltatásnév-profilt jelöl.

Name	Típus	Description
displayName	string	Az egyszerű megjelenítendő neve.
id	string (uuid)	Az igazgató azonosítója.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	A szolgáltatásnév profiladatai. Akkor alkalmazható, ha az egyszerű típus `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.

SparkLibraries

Tárgy

Spark-kódtárak.

Name	Típus	Description
state	EnvironmentPublishState	Közzétételi állapot. Idővel további állapottípusok is hozzáadhatók.

SparkSettings

Tárgy

Spark-beállítások.

Name	Típus	Description
state	EnvironmentPublishState	Közzétételi állapot. Idővel további állapottípusok is hozzáadhatók.

UserDetails

Tárgy

A felhasználó egyszerű adatai. Akkor alkalmazható, ha az egyszerű típus User.

Name	Típus	Description
userPrincipalName	string	A felhasználói főnév.

UserPrincipal

Tárgy

Egy Microsoft Entra felhasználónevet jelöl.

Name	Típus	Description
displayName	string	Az egyszerű megjelenítendő neve.
id	string (uuid)	Az igazgató azonosítója.
type	string: User	A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.
userDetails	UserDetails	A felhasználó egyszerű adatai. Akkor alkalmazható, ha az egyszerű típus `User`.