Items - List Environments

Palvelu:: Environment

Ohjelmointirajapinnan versio:: v1

Palauttaa määritetyn työtilan ympäristöluettelon.
Tämä ohjelmointirajapinta tukee sivutuksen.

Käyttöoikeudet

Soittajalla on oltava katselijan työtilan rooli.

Vaaditut delegoidut vaikutusalueet

Workspace.Read.All tai Workspace.ReadWrite.All

tuettujen käyttäjätietojen Microsoft Entra

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft identities.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Rajapinta

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

Valinnaisilla parametreilla:

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
workspaceId	path	True	string (uuid)	Työtilan tunnus.
continuationToken	query		string	Tunnus seuraavan tulossivun noutamiseen.
recursive	query		boolean	Näyttää luettelon kansion kohteista ja sen sisäkkäsistä kansioista, tai vain kansiosta. True – Kaikki kansion kohteet ja niiden sisäkkäiset kansiot näkyvät luettelossa, False – vain kansiossa olevat kohteet luetellaan. Oletusarvo on true.
rootFolderId	query		string (uuid)	Tämän parametrin avulla käyttäjät voivat suodattaa kohteita tietyn pääkansion perusteella. Jos tätä ei anneta, työtilaa käytetään pääkansiona.

Vastaukset

Nimi Tyyppi Description

200 OK

Nimi	Tyyppi	Description
200 OK	Environments	Pyynnön valmistuttua.
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: InvalidItemType – Virheellinen kohdetyyppi

Environments

Pyynnön valmistuttua.

429 Too Many Requests

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

InvalidItemType – Virheellinen kohdetyyppi

Esimerkit

List environments in workspace example

Mallipyyntö

HTTP

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

Mallivastaus

Tilakoodi:: 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"
      }
    }
  ]
}

Määritelmät

Nimi	Description
ComponentPublishInfo	Julkaise ympäristön kunkin komponentin tiedot.
EntireTenantPrincipal	Edustaa vuokraajan päänimeä
Environment	Ympäristö-kohde.
EnvironmentProperties	Ympäristön ominaisuudet.
EnvironmentPublishState	Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.
Environments	Luettelo ympäristöistä.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
GroupDetails	Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on `Group`.
GroupPrincipal	Edustaa käyttöoikeusryhmää.
GroupType	Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.
ItemTag	Edustaa kohteelle käytettyä tunnistetta.
ItemType	Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.
PrincipalType	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.
PublishDetails	Julkaisutoiminnon tiedot.
SensitivityLabel	Edustaa kohteelle käytettyä luottamuksellisuustunnistetta.
ServicePrincipalDetails	Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `ServicePrincipal`.
ServicePrincipalPrincipal	Ilmaisee Microsoft Entra palvelun päänimen.
ServicePrincipalProfileDetails	Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Edustaa palvelun pääprofiilia.
SparkLibraries	Spark-kirjastot.
SparkSettings	Spark-asetukset.
UserDetails	Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `User`.
UserPrincipal	Edustaa Microsoft Entra käyttäjäobjektia.

ComponentPublishInfo

Kohde

Julkaise ympäristön kunkin komponentin tiedot.

Nimi	Tyyppi	Description
sparkLibraries	SparkLibraries	Spark-kirjastot julkaisevat tietoja.
sparkSettings	SparkSettings	Spark-asetusten julkaisutiedot.

EntireTenantPrincipal

Kohde

Edustaa vuokraajan päänimeä

Nimi	Tyyppi	Description
displayName	string	Tämä on päänimen näyttönimi.
id	string (uuid)	Päänimen tunnus.
type	string: EntireTenant	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

Environment

Kohde

Ympäristö-kohde.

Nimi	Tyyppi	Description
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Kohteen oletusarvoiset käyttäjätiedot.
description	string	Kohteen kuvaus.
displayName	string	Kohteen näyttönimi.
folderId	string (uuid)	Kansion tunnus.
id	string (uuid)	Kohdetunnus.
properties	EnvironmentProperties	Ympäristön ominaisuudet.
sensitivityLabel	SensitivityLabel	Kohteen luottamuksellisuustunniste.
tags	ItemTag[]	Luettelo käytössä olevista tunnisteista.
type	ItemType	Kohdetyyppi.
workspaceId	string (uuid)	Työtilan tunnus.

EnvironmentProperties

Kohde

Ympäristön ominaisuudet.

Nimi	Tyyppi	Description
publishDetails	PublishDetails	Ympäristön julkaisutoiminnon tiedot.

EnvironmentPublishState

Luettelointi

Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
Success	Ympäristön julkaiseminen on onnistumistilassa.
Cancelled	Ympäristön julkaiseminen on peruutettuna.
Failed	Ympäristön julkaisu on epäonnistuneessa tilassa.
Cancelling	Ympäristön julkaisu on peruuttamassa tilaa.
Running	Ympäristön julkaisu on käynnissä-tilassa.
Waiting	Ympäristön julkaisu on odotustilassa.

Environments

Kohde

Luettelo ympäristöistä.

Nimi	Tyyppi	Description
continuationToken	string	Seuraavan tulosjoukkoerän tunnus. Jos tietueita ei ole enempää, ne poistetaan vastauksesta.
continuationUri	string	Seuraavan tulosjoukkoerän URI. Jos tietueita ei ole enempää, ne poistetaan vastauksesta.
value	Environment[]	Luettelo ympäristöistä.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

GroupDetails

Kohde

Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on Group.

Nimi	Tyyppi	Description
groupType	GroupType	Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.

GroupPrincipal

Kohde

Edustaa käyttöoikeusryhmää.

Nimi	Tyyppi	Description
displayName	string	Tämä on päänimen näyttönimi.
groupDetails	GroupDetails	Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on `Group`.
id	string (uuid)	Päänimen tunnus.
type	string: Group	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

GroupType

Luettelointi

Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.

Arvo	Description
Unknown	Pääryhmän tyyppi on tuntematon.
SecurityGroup	Principal on käyttöoikeusryhmä.
DistributionList	Principal on jakeluluettelo.

ItemTag

Kohde

Edustaa kohteelle käytettyä tunnistetta.

Nimi	Tyyppi	Description
displayName	string	Tunnisteen nimi.
id	string (uuid)	Tunnisteen tunnus.

ItemType

Luettelointi

Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
Dashboard	Power BI -koontinäyttö.
Report	PowerBI -raportti.
SemanticModel	PowerBI:n semanttinen malli.
PaginatedReport	PowerBI:n sivutettu raportti.
Datamart	PowerBI -tietomarssi.
Lakehouse	Tämä on lakehouse.
Eventhouse	Tapahtumatalo.
Environment	Ympäristö.
KQLDatabase	KQL-tietokanta.
KQLQueryset	KQL-kyselyjoukko.
KQLDashboard	KQL-koontinäyttö.
DataPipeline	Tietoputki.
Notebook	Muistikirja.
SparkJobDefinition	Spark-työn määritelmä.
MLExperiment	Koneoppimisen kokeilu.
MLModel	Koneoppimismalli.
Warehouse	Varasto.
Eventstream	Tapahtumavirta.
SQLEndpoint	SQL-päätepiste.
MirroredWarehouse	Peilattu varasto.
MirroredDatabase	Peilattu tietokanta.
Reflex	Refleksi.
GraphQLApi	Ohjelmointirajapinta GraphQL-kohteelle.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Kopiotyö.
VariableLibrary	MuuttujaLibrary.
Dataflow	Tietovuo.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Varastotilannevedos.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digital Twin Builder -työnkulku.
MirroredAzureDatabricksCatalog	Peilattu Azure Databricks -luettelo.
Map	Kartta.
AnomalyDetector	Poikkeamien tunnistaminen.
UserDataFunction	Käyttäjätietofunktio.
GraphModel	A GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	Snowflake-tietokannalla tallennetaan Snowflake-tililtä luodut Iceberg-taulukot.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Cosmos DB -tietokanta.
Ontology	Ontologia.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.

PrincipalType

Luettelointi

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
User	Principal on Microsoft Entra käyttäjäobjekti.
ServicePrincipal	Principal on Microsoft Entra palvelun päänimi.
Group	Principal on käyttöoikeusryhmä.
ServicePrincipalProfile	Principal on palvelun pääprofiili.
EntireTenant	Principal edustaa kaikkia vuokraajan käyttäjiä.

PublishDetails

Kohde

Julkaisutoiminnon tiedot.

Nimi	Tyyppi	Description
componentPublishInfo	ComponentPublishInfo	Ympäristön osan julkaisutiedot.
endTime	string (date-time)	Julkaisutoiminnon päättymisaika UTC-muodossa VVVV-KK-PPTHH:mm:ss.ssssssZ.
startTime	string (date-time)	Julkaisutoiminnon alkamisaika UTC-muodossa VVVV-KK-PPTHH:mm:ss.ssssssZ.
state	EnvironmentPublishState	Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.
targetVersion	string (uuid)	Target verion julkaistaan.

SensitivityLabel

Kohde

Edustaa kohteelle käytettyä luottamuksellisuustunnistetta.

Nimi	Tyyppi	Description
id	string (uuid)	Tämä on luottamuksellisuustunnisteen tunnus.

ServicePrincipalDetails

Kohde

Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on ServicePrincipal.

Nimi	Tyyppi	Description
aadAppId	string (uuid)	Palvelun päänimen Microsoft Entra AppId.

ServicePrincipalPrincipal

Kohde

Ilmaisee Microsoft Entra palvelun päänimen.

Nimi	Tyyppi	Description
displayName	string	Tämä on päänimen näyttönimi.
id	string (uuid)	Päänimen tunnus.
servicePrincipalDetails	ServicePrincipalDetails	Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `ServicePrincipal`.
type	string: ServicePrincipal	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

ServicePrincipalProfileDetails

Kohde

Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on ServicePrincipalProfile.

Nimi	Tyyppi	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Palvelun pääprofiilin pääobjekti.

ServicePrincipalProfilePrincipal

Kohde

Edustaa palvelun pääprofiilia.

Nimi	Tyyppi	Description
displayName	string	Tämä on päänimen näyttönimi.
id	string (uuid)	Päänimen tunnus.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

SparkLibraries

Kohde

Spark-kirjastot.

Nimi	Tyyppi	Description
state	EnvironmentPublishState	Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.

SparkSettings

Kohde

Spark-asetukset.

Nimi	Tyyppi	Description
state	EnvironmentPublishState	Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.

UserDetails

Kohde

Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on User.

Nimi	Tyyppi	Description
userPrincipalName	string	Täydellinen käyttäjänimi.

UserPrincipal

Kohde

Edustaa Microsoft Entra käyttäjäobjektia.

Nimi	Tyyppi	Description
displayName	string	Tämä on päänimen näyttönimi.
id	string (uuid)	Päänimen tunnus.
type	string: User	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.
userDetails	UserDetails	Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `User`.

Jaa

Items - List Environments

Käyttöoikeudet

Vaaditut delegoidut vaikutusalueet

tuettujen käyttäjätietojen Microsoft Entra

Rajapinta

URI-parametrit

Vastaukset

Esimerkit

List environments in workspace example

Mallipyyntö

Mallivastaus

Määritelmät

ComponentPublishInfo

EntireTenantPrincipal

Environment

EnvironmentProperties

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupPrincipal

GroupType

ItemTag

ItemType

PrincipalType

PublishDetails

SensitivityLabel

ServicePrincipalDetails

ServicePrincipalPrincipal

ServicePrincipalProfileDetails

ServicePrincipalProfilePrincipal

SparkLibraries

SparkSettings

UserDetails

UserPrincipal