Items - Update Environment

Υπηρεσία:

Environment

Έκδοση API:

v1

Ενημερώνει τις ιδιότητες του καθορισμένου περιβάλλοντος.

Δικαιώματα

Ο καλών πρέπει να έχει συνεισφέροντα ή μεγαλύτερο ρόλο χώρου εργασίας.

Απαιτούμενες εμβέλειες με ανάθεση

Environment.ReadWrite.All ή Item.ReadWrite.All

Υποστηριζόμενες ταυτότητες Microsoft Entra

Αυτό το API υποστηρίζει τις ταυτότητες Microsoft που παρατίθενται σε αυτή την ενότητα.

Ταυτότητα	Υποστηρίζω
Χρήστης	Ναι
Υπηρεσίας και διαχειριζόμενες ταυτότητες	Ναι

Διεπαφή

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

Παράμετροι URI

Όνομα	Σε	Απαιτείται	Τύπος	Περιγραφή
environmentId	path	True	string (uuid)	Το αναγνωριστικό περιβάλλοντος.
workspaceId	path	True	string (uuid)	Το αναγνωριστικό χώρου εργασίας.

Κυρίως τμήμα αίτησης

Όνομα	Τύπος	Περιγραφή
description	string	Η περιγραφή του περιβάλλοντος. Το μέγιστο μήκος είναι 256 χαρακτήρες.
displayName	string	Το εμφανιζόμενο όνομα του περιβάλλοντος.

Αποκρίσεις

Όνομα	Τύπος	Περιγραφή
200 OK	Environment	Η αίτηση ολοκληρώθηκε με επιτυχία.
Other Status Codes	ErrorResponse	Συνήθεις κωδικοί σφαλμάτων: ItemNotFound - Το στοιχείο που ζητήθηκε δεν βρέθηκε. Μη έγκυρη αίτηση - Αίτηση μη έγκυρης ενημέρωσης

Παραδείγματα

Update a environment example

Δείγμα αίτησης

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Environment_New_Name",
  "description": "A new description for environment."
}

Δείγμα απόκρισης

Κωδικός κατάστασης:

200

{
  "displayName": "Environment_New_Name",
  "description": "A new description for environment.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Ορισμοί

Όνομα	Περιγραφή
ComponentPublishInfo	Δημοσιεύστε πληροφορίες για κάθε στοιχείο στο περιβάλλον.
Environment	Ένα στοιχείο περιβάλλοντος.
EnvironmentPublishInfo	Πληροφορίες δημοσίευσης περιβάλλοντος.
EnvironmentPublishState	Δημοσιεύστε την πολιτεία. Πρόσθετοι τύποι πολιτειών μπορούν να προστεθούν με την πάροδο του χρόνου.
ErrorRelatedResource	Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.
ErrorResponse	Η απόκριση σφάλματος.
ErrorResponseDetails	Οι λεπτομέρειες της απόκρισης σφάλματος.
ItemType	Ο τύπος του στοιχείου. Επιπλέον τύποι στοιχείων μπορούν να προστεθούν με την πάροδο του χρόνου.
PublishDetails	Λεπτομέρειες της λειτουργίας δημοσίευσης.
SparkLibraries	Βιβλιοθήκες Spark.
SparkSettings	Ρυθμίσεις Spark.
UpdateEnvironmentRequest	Ενημέρωση αίτησης περιβάλλοντος.

ComponentPublishInfo

Object

Δημοσιεύστε πληροφορίες για κάθε στοιχείο στο περιβάλλον.

Όνομα	Τύπος	Περιγραφή
sparkLibraries	SparkLibraries	Οι βιβλιοθήκες Spark δημοσιεύουν πληροφορίες.
sparkSettings	SparkSettings	Οι ρυθμίσεις Spark δημοσιεύουν πληροφορίες.

Environment

Object

Ένα στοιχείο περιβάλλοντος.

Όνομα	Τύπος	Περιγραφή
description	string	Η περιγραφή του στοιχείου.
displayName	string	Το εμφανιζόμενο όνομα του στοιχείου.
folderId	string (uuid)	Το αναγνωριστικό φακέλου.
id	string (uuid)	Το αναγνωριστικό στοιχείου.
properties	EnvironmentPublishInfo	Οι ιδιότητες περιβάλλοντος.
type	ItemType	Ο τύπος στοιχείου.
workspaceId	string (uuid)	Το αναγνωριστικό χώρου εργασίας.

EnvironmentPublishInfo

Object

Πληροφορίες δημοσίευσης περιβάλλοντος.

Όνομα	Τύπος	Περιγραφή
publishDetails	PublishDetails	Λεπτομέρειες λειτουργίας δημοσίευσης περιβάλλοντος.

EnvironmentPublishState

Απαρίθμηση

Δημοσιεύστε την πολιτεία. Πρόσθετοι τύποι πολιτειών μπορούν να προστεθούν με την πάροδο του χρόνου.

Τιμή	Περιγραφή
Cancelled	Η δημοσίευση περιβάλλοντος είναι σε ακυρωμένη κατάσταση.
Cancelling	Η δημοσίευση περιβάλλοντος είναι σε κατάσταση ακύρωσης.
Failed	Η δημοσίευση περιβάλλοντος είναι σε κατάσταση αποτυχίας.
Running	Η δημοσίευση περιβάλλοντος είναι σε κατάσταση εκτέλεσης.
Success	Η δημοσίευση περιβάλλοντος είναι σε κατάσταση επιτυχίας.
Waiting	Η δημοσίευση περιβάλλοντος είναι σε κατάσταση αναμονής.

ErrorRelatedResource

Object

Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.

Όνομα	Τύπος	Περιγραφή
resourceId	string	Το αναγνωριστικό πόρου που εμπλέκεται στο σφάλμα.
resourceType	string	Ο τύπος του πόρου που εμπλέκεται στο σφάλμα.

ErrorResponse

Object

Η απόκριση σφάλματος.

Όνομα	Τύπος	Περιγραφή
errorCode	string	Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
message	string	Μια αναγνώσιμη αναπαράσταση του σφάλματος.
moreDetails	ErrorResponseDetails[]	Λίστα πρόσθετων λεπτομερειών σφάλματος.
relatedResource	ErrorRelatedResource	Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.
requestId	string	Το αναγνωριστικό της αίτησης που σχετίζεται με το σφάλμα.

ErrorResponseDetails

Object

Οι λεπτομέρειες της απόκρισης σφάλματος.

Όνομα	Τύπος	Περιγραφή
errorCode	string	Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
message	string	Μια αναγνώσιμη αναπαράσταση του σφάλματος.
relatedResource	ErrorRelatedResource	Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.

ItemType

Απαρίθμηση

Ο τύπος του στοιχείου. Επιπλέον τύποι στοιχείων μπορούν να προστεθούν με την πάροδο του χρόνου.

Τιμή	Περιγραφή
CopyJob	Μια εργασία αντιγραφής.
Dashboard	Πίνακας εργαλείων του PowerBI.
DataPipeline	Μια διοχέτευση δεδομένων.
Datamart	Datamart του PowerBI.
Environment	Ένα περιβάλλον.
Eventhouse	Μια εκδήλωση.
Eventstream	Μια ροή συμβάντος.
GraphQLApi	Ένα API για το στοιχείο GraphQL.
KQLDashboard	Ένας πίνακας εργαλείων KQL.
KQLDatabase	Μια βάση δεδομένων KQL.
KQLQueryset	Ένα σύνολο ερωτημάτων KQL.
Lakehouse	Ένα λιμνοθάσπιτο.
MLExperiment	Ένα πείραμα εκμάθησης μηχανής.
MLModel	Ένα μοντέλο εκμάθησης μηχανής.
MirroredDatabase	Μια βάση δεδομένων κατοπτρισμού.
MirroredWarehouse	Μια αποθήκη με κατοπτρικό καθρέφτη.
MountedDataFactory	A MountedDataFactory.
Notebook	Ένα σημειωματάριο.
PaginatedReport	Σελιδοποιημένη αναφορά PowerBI.
Reflex	Αντανακλαστικά.
Report	Αναφορά PowerBI.
SQLDatabase	Μια βάση δεδομένων SQL.
SQLEndpoint	Ένα τελικό σημείο SQL.
SemanticModel	Σημασιολογικό μοντέλο PowerBI.
SparkJobDefinition	Ένας ορισμός εργασίας σπινθήρα.
VariableLibrary	Μια μεταβλητήLibrary.
Warehouse	Μια αποθήκη.

PublishDetails

Object

Λεπτομέρειες της λειτουργίας δημοσίευσης.

Όνομα	Τύπος	Περιγραφή
componentPublishInfo	ComponentPublishInfo	Το στοιχείο περιβάλλοντος δημοσιεύει πληροφορίες.
endTime	string (date-time)	Ώρα λήξης της λειτουργίας δημοσίευσης.
startTime	string (date-time)	Ώρα έναρξης της λειτουργίας δημοσίευσης.
state	EnvironmentPublishState	Δημοσιεύστε την πολιτεία. Πρόσθετοι τύποι πολιτειών μπορούν να προστεθούν με την πάροδο του χρόνου.
targetVersion	string (uuid)	Έκδοση-στόχος προς δημοσίευση.

SparkLibraries

Object

Βιβλιοθήκες Spark.

Όνομα	Τύπος	Περιγραφή
state	EnvironmentPublishState	Δημοσιεύστε την πολιτεία. Πρόσθετοι τύποι πολιτειών μπορούν να προστεθούν με την πάροδο του χρόνου.

SparkSettings

Object

Ρυθμίσεις Spark.

Όνομα	Τύπος	Περιγραφή
state	EnvironmentPublishState	Δημοσιεύστε την πολιτεία. Πρόσθετοι τύποι πολιτειών μπορούν να προστεθούν με την πάροδο του χρόνου.

UpdateEnvironmentRequest

Object

Ενημέρωση αίτησης περιβάλλοντος.

Όνομα	Τύπος	Περιγραφή
description	string	Η περιγραφή του περιβάλλοντος. Το μέγιστο μήκος είναι 256 χαρακτήρες.
displayName	string	Το εμφανιζόμενο όνομα του περιβάλλοντος.