Items - List Environments

Tjeneste:: Environment

API-version:: v1

Returnerer en liste over miljøer fra det angivne arbejdsområde.
Denne API understøtter sideinddeling.

Tilladelser

Den, der ringer op, skal have en seerarbejdsområderolle .

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.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

Med valgfrie parametre:

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
continuationToken	query		string	Et token til hentning af den næste side med resultater.

Svar

Name	Type	Beskrivelse
200 OK	Environments	Anmodningen blev fuldført.
Other Status Codes	ErrorResponse	Almindelige fejlkoder: InvalidItemType – Ugyldig elementtype

Name

Type

Beskrivelse

200 OK

Environments

Anmodningen blev fuldført.

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

InvalidItemType – Ugyldig elementtype

Eksempler

List environments in workspace example

Eksempelanmodning

HTTP

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

Eksempelsvar

Statuskode:: 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"
            }
          }
        }
      }
    },
    {
      "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"
            }
          }
        }
      }
    }
  ]
}

Definitioner

Name	Beskrivelse
ComponentPublishInfo	Publicer oplysninger om de enkelte komponenter i miljøet.
Environment	Et miljøelement.
EnvironmentProperties	Miljøegenskaber.
EnvironmentPublishState	Publicer tilstand. Der kan tilføjes flere tilstandstyper over tid.
Environments	En liste over miljøer.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
ItemTag	Repræsenterer et mærke, der er anvendt på et element.
ItemType	Elementets type. Der kan tilføjes flere elementtyper over tid.
PublishDetails	Oplysninger om publiceringshandlingen.
SparkLibraries	Spark-biblioteker.
SparkSettings	Spark-indstillinger.

ComponentPublishInfo

Objekt

Publicer oplysninger om de enkelte komponenter i miljøet.

Name	Type	Beskrivelse
sparkLibraries	SparkLibraries	Oplysninger om udgivelse af Spark-biblioteker.
sparkSettings	SparkSettings	Oplysninger om udgivelse af Spark-indstillinger.

Environment

Objekt

Et miljøelement.

Name	Type	Beskrivelse
description	string	Elementbeskrivelsen.
displayName	string	Det viste elementnavn.
folderId	string (uuid)	Mappe-id'et.
id	string (uuid)	Element-id'et.
properties	EnvironmentProperties	Miljøegenskaberne.
tags	ItemTag[]	Liste over anvendte mærker.
type	ItemType	Elementtypen.
workspaceId	string (uuid)	Arbejdsområde-id'et.

EnvironmentProperties

Objekt

Miljøegenskaber.

Name	Type	Beskrivelse
publishDetails	PublishDetails	Oplysninger om publicering af miljøhandling.

EnvironmentPublishState

Optælling

Publicer tilstand. Der kan tilføjes flere tilstandstyper over tid.

Værdi	Beskrivelse
Success	Publicering af miljø er i succestilstand.
Cancelled	Publicering af miljøet er i annulleret tilstand.
Failed	Publiceringen af miljøet er i mislykket tilstand.
Cancelling	Publicering af miljø er i annulleringstilstand.
Running	Publicering af miljø er i kørselstilstand.
Waiting	Publicering af miljø er i ventetilstand.

Environments

Objekt

En liste over miljøer.

Name	Type	Beskrivelse
continuationToken	string	Tokenet for det næste resultatsætbatch. Hvis der ikke er flere poster, fjernes de fra svaret.
continuationUri	string	URI'en for det næste resultatsætbatch. Hvis der ikke er flere poster, fjernes de fra svaret.
value	Environment[]	En liste over miljøer.

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	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.

ItemTag

Objekt

Repræsenterer et mærke, der er anvendt på et element.

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

ItemType

Optælling

Elementets type. Der kan tilføjes flere elementtyper over tid.

Værdi	Beskrivelse
Dashboard	PowerBI-dashboard.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-model.
PaginatedReport	Sideinddelt PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et søhus.
Eventhouse	Et eventhouse.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-forespørgselssæt.
KQLDashboard	Et KQL-dashboard.
DataPipeline	En datapipeline.
Notebook	En notesbog.
SparkJobDefinition	En spark jobdefinition.
MLExperiment	Et maskinel indlæringseksperiment.
MLModel	En model til maskinel indlæring.
Warehouse	Et lager.
Eventstream	En hændelsesstream.
SQLEndpoint	Et SQL-slutpunkt.
MirroredWarehouse	Et spejlvendt lager.
MirroredDatabase	En spejlet database.
Reflex	En refleks.
GraphQLApi	En API til GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Et kopijob.
VariableLibrary	En VariabelLibrary.
Dataflow	Et dataflow.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et lagersnapshot.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Et Digital Twin Builder-flow.
MirroredAzureDatabricksCatalog	Et spejlet Azure Databricks-katalog.
Map	Et kort.
AnomalyDetector	En uregelmæssighedsregistrering.
UserDataFunction	En brugerdatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	Et Graph QuerySet.
SnowflakeDatabase	En Snowflake-database til lagring af Iceberg-tabeller, der er oprettet fra Snowflake-konto.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.
Ontology	En ontologi.
EventSchemaSet	Et EventSchemaSet.

PublishDetails

Objekt

Oplysninger om publiceringshandlingen.

Name	Type	Beskrivelse
componentPublishInfo	ComponentPublishInfo	Publicer oplysninger om miljøkomponent.
endTime	string (date-time)	Sluttidspunktet for publiceringshandlingen i UTC ved hjælp af formatet YYYY-MM-DDTHH:mm:ss.ssssssZ.
startTime	string (date-time)	Starttidspunktet for publiceringshandlingen i UTC ved hjælp af formatet YYYY-MM-DDTHH:mm:ss.ssssssZ.
state	EnvironmentPublishState	Publicer tilstand. Der kan tilføjes flere tilstandstyper over tid.
targetVersion	string (uuid)	Målversion, der skal publiceres.

SparkLibraries

Objekt

Spark-biblioteker.

Name	Type	Beskrivelse
state	EnvironmentPublishState	Publicer tilstand. Der kan tilføjes flere tilstandstyper over tid.

SparkSettings

Objekt

Spark-indstillinger.

Name	Type	Beskrivelse
state	EnvironmentPublishState	Publicer tilstand. Der kan tilføjes flere tilstandstyper over tid.

Del via

Items - List Environments

Tilladelser

Påkrævede delegerede områder

Microsoft Entra-understøttede identiteter

Grænseflade

URI-parametre

Svar

Eksempler

List environments in workspace example

Eksempelanmodning

Eksempelsvar

Definitioner

ComponentPublishInfo

Environment

EnvironmentProperties

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PublishDetails

SparkLibraries

SparkSettings