Διαχείριση του περιβάλλοντος μέσω δημόσιων API

Το API REST του Microsoft Fabric παρέχει ένα τελικό σημείο υπηρεσίας για τις λειτουργίες δημιουργίας, ανάγνωσης, ενημέρωσης και διαγραφής (CRUD) ενός στοιχείου Fabric. Αυτό το άρθρο περιγράφει τα διαθέσιμα API REST περιβάλλοντος και τη χρήση τους.

Σύνοψη των API περιβάλλοντος

Μάθετε περισσότερα σχετικά με τα υπάρχοντα δημόσια API περιβάλλοντος στα API στοιχείων - Περιβάλλον

Λεπτομέρειες ενημέρωσης δημόσιου API περιβάλλοντος

Αυτή η ενότητα περιγράφει τις μελλοντικές ενημερώσεις για τα υπάρχοντα API.

Λήψη περιβάλλοντος

Στην απόκριση του API Λήψη περιβάλλοντος, το "startTime" θα γίνει "startDateTime" και το "endTime" θα γίνει "endDateTime". Αντιπροσωπεύουν την ώρα έναρξης/λήξης της λειτουργίας δημοσίευσης.

• Διασύνδεση

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

• Αρχικό δείγμα απόκρισης

  {
    "displayName": "Environment_1",
    "description": "An Environment description",
    "type": "Environment",
    "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
    "id": "5b218778-e7a5-4d73-8187-f10824047715",
    "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"
          }
        }
      }
    }
  }
  

• Νέο δείγμα απόκρισης

  {
    "displayName": "Environment_1",
    "description": "An Environment description",
    "type": "Environment",
    "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
    "id": "5b218778-e7a5-4d73-8187-f10824047715",
    "properties": {
      "publishDetails": {
        "state": "Success",
        "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
        "startDateTime": "2024-03-29T14:17:09Z",
        "endDateTime": "2024-03-29T14:48:09Z",
        "componentPublishInfo": {
          "sparkLibraries": {
            "state": "Success"
          },
          "sparkSettings": {
            "state": "Success"
          }
        }
      }
    }
  }
  

Δημοσίευση περιβάλλοντος

Η δημοσίευση API περιβάλλοντος θα υποστηρίζει λειτουργίες μεγάλης διάρκειας ξεκινώντας από την έκδοση, η σύμβαση της απόκρισης θα αλλάξει. Το τελικό σημείο παραμένει το ίδιο για την αποστολή αιτήσεων.

• Διασύνδεση

  POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/publish
  

• Αρχικό δείγμα απόκρισης

  {
    "publishDetails": {
      "state": "Running",
      "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
      "startTime": "2024-03-29T14:17:09.0697022Z",
      "componentPublishInfo": {
        "sparkLibraries": {
          "state": "Running"
        },
        "sparkSettings": {
          "state": "Running"
        }
      }
    }
  }
  

• Νέο δείγμα απόκρισης

  
  Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69
  x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69
  Retry-After: 60
  
  

Λίστα προεργασίας/δημοσιευμένων βιβλιοθηκών

Αυτά τα δύο API μπορούν να λάβουν την πλήρη λίστα των βιβλιοθηκών προεργασίας/δημοσίευσης του περιβάλλοντος. Τα τελικά σημεία παραμένουν τα ίδια για την αποστολή αιτήσεων, ενώ οι βιβλιοθήκες θα επιστρέφονται με διαφορετική δομή.

• Διασυνδέσεις

  Λήψη βιβλιοθηκών προετοιμασίας

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

  Λήψη δημοσιευμένων βιβλιοθηκών

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

• Αρχικό δείγμα απόκρισης

  
  {
    "customLibraries": {
      "wheelFiles": [
        "samplewheel-0.18.0-py2.py3-none-any.whl"
      ],
      "pyFiles": [
        "samplepython.py"
      ],
      "jarFiles": [
        "samplejar.jar"
      ],
      "rTarFiles": [
        "sampleR.tar.gz"
      ]
    },
    "environmentYml": "dependencies:\r\n- pip:\r\n  - matplotlib==3.4.3"
  }
  
  

• Νέο δείγμα απόκρισης

  {
    "libraries": [
      {
        "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
        "libraryType": "Custom"
      },
      {
        "name": "samplepython.py",
        "libraryType": "Custom"
      },
      {
        "name": "samplejar.jar",
        "libraryType": "Custom"
      },
      {
        "name": "sampleR.tar.gz",
        "libraryType": "Custom"
      },
      {
        "name": "fuzzywuzzy",
        "libraryType": "External",
        "version": "0.0.1"
      },
      {
        "name": "matplotlib",
        "libraryType": "External",
        "version": "0.0.1"
      }
    ],
    "continuationToken": "null",
    "continuationUri": "null"
  }
  
  

Λίστα προεργασίας/δημοσιευμένων ρυθμίσεων Spark

Αυτά τα δύο API μπορούν να λάβουν τις ρυθμίσεις παραμέτρων υπολογιστικής λειτουργίας Spark και τις ιδιότητες του περιβάλλοντος. Τα τελικά σημεία παραμένουν τα ίδια για την αποστολή αιτήσεων, ενώ οι ρυθμίσεις παραμέτρων θα επιστρέφονται με διαφορετική δομή. Οι ιδιότητες Spark θα αλλάξουν σε λίστα.

• Διασυνδέσεις

  Λήψη ρυθμίσεων Spark προεργασίας

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

  Λήψη δημοσιευμένων ρυθμίσεων Spark

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

• Αρχικό δείγμα απόκρισης

  {
    "instancePool": {
      "name": "MyWorkspacePool",
      "type": "Workspace",
      "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
    },
    "driverCores": 4,
    "driverMemory": "56g",
    "executorCores": 4,
    "executorMemory": "56g",
    "dynamicExecutorAllocation": {
      "enabled": false,
      "minExecutors": 1,
      "maxExecutors": 1
    },
    "sparkProperties": {
      "spark.acls.enable": "false"
    },
    "runtimeVersion": "1.2"
  }
  

• Νέο δείγμα απόκρισης

  {
    "instancePool": {
      "name": "MyWorkspacePool",
      "type": "Workspace",
      "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
    },
    "driverCores": "4",
        "driverMemory": "56G",
    "executorCores": "4",
    "executorMemory": "56G",
    "dynamicExecutorAllocation": {
      "enabled": false,
      "minExecutors": 1,
      "maxExecutors": 1
    },
    "sparkProperties": [
      {
        "key": "spark.acls.enable",
        "value": "false"
      }
    ],
    "runtimeVersion": "1.2"
  }
  

Ενημέρωση ρυθμίσεων Spark

Αυτό το API προορίζεται για την ενημέρωση της υπολογιστικής λειτουργίας Spark και των ιδιοτήτων ενός περιβάλλοντος. Η σύμβαση της ιδιότητας Spark σε αίτηση και απόκριση θα ενημερωθεί μόλις ολοκληρωθεί η κυκλοφορία.

• Αρχικό δείγμα αίτησης

  PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute
  
  {
    "instancePool": {
      "name": "MyWorkspacePool",
      "type": "Workspace"
    },
    "driverCores": 4,
    "driverMemory": "56g",
    "executorCores": 4,
    "executorMemory": "56g",
    "dynamicExecutorAllocation": {
      "enabled": false,
      "minExecutors": 1,
      "maxExecutors": 1
    },
    "sparkProperties": {
      "spark.acls.enable": "false",
      "spark.admin.acls": null
    },
    "runtimeVersion": "1.2"
  }
  

• Νέο δείγμα αίτησης

  PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute
  
  {
    "instancePool": {
      "name": "MyWorkspacePool",
      "type": "Workspace"
    },
    "driverCores": "4",
    "driverMemory": "56G",
    "executorCores": "4",
    "executorMemory": "56G",
    "dynamicExecutorAllocation": {
      "enabled": false,
      "minExecutors": 1,
      "maxExecutors": 1
    },
    "sparkProperties": [
      {
        "key": "spark.acls.enable",
        "value": "false"
      },
      {
        "key": "spark.admin.acls",
        "value": null
      }
    ],
    "runtimeVersion": "1.2"
  }
  

• Αρχικό δείγμα απόκρισης

  {
    "instancePool": {
      "name": "MyWorkspacePool",
      "type": "Workspace",
      "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
    },
    "driverCores": 4,
    "driverMemory": "56g",
    "executorCores": 4,
    "executorMemory": "56g",
    "dynamicExecutorAllocation": {
      "enabled": false,
      "minExecutors": 1,
      "maxExecutors": 1
    },
    "sparkProperties": {
      "spark.acls.enable": "false"
    },
    "runtimeVersion": "1.2"
  }
  

• Νέο δείγμα απόκρισης

  {
    "instancePool": {
      "name": "MyWorkspacePool",
      "type": "Workspace",
      "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
    },
    "driverCores": "4",
    "driverMemory": "56G",
    "executorCores": "4",
    "executorMemory": "56G",
    "dynamicExecutorAllocation": {
      "enabled": false,
      "minExecutors": 1,
      "maxExecutors": 1
    },
    "sparkProperties": [
      {
        "key": "spark.acls.enable",
        "value": "false"
      }
    ],
    "runtimeVersion": "1.2"
  }
  

Περιπτώσεις χρήσης δημόσιου API περιβάλλοντος

Αυτή η ενότητα παρουσιάζει τον τρόπο χρήσης των διαθέσιμων API για την επίτευξη συγκεκριμένων στόχων. Μπορείτε να αντικαταστήσετε τα {WORKSPACE_ID} και {ARTIFACT_ID} στα παρακάτω παραδείγματα με κατάλληλες τιμές.

Δημιουργία νέου περιβάλλοντος

Μπορείτε να δημιουργήσετε ένα νέο κενό περιβάλλον χρησιμοποιώντας το παρακάτω API.

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

  POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments
  
  {
      "displayName": "Environment_1",
      "description": "An environment description"
  }
  

Διαχείριση βιβλιοθηκών προεργασίας

Μπορείτε να χρησιμοποιήσετε τα API βιβλιοθηκών αποστολής/διαγραφής προεργασίας για να διαχειριστείτε την ενότητα βιβλιοθήκης στο περιβάλλον

Έλεγχος δημοσιευμένων βιβλιοθηκών για το περιβάλλον

Πριν από την προσθήκη/διαγραφή της βιβλιοθήκης, μπορείτε να χρησιμοποιήσετε το API βιβλιοθηκών λήψης δημοσιεύσεων για να ελέγξετε ποιες βιβλιοθήκες είναι αποτελεσματικές αυτήν τη στιγμή.

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

  GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/libraries
  

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

  {
      "customLibraries": {
          "wheelFiles": [
              "samplewheel-0.18.0-py2.py3-none-any.whl"
          ],
          "pyFiles": [
              "samplepython.py"
          ],
          "jarFiles": [
              "samplejar.jar"
          ],
          "rTarFiles": [
              "sampleR.tar.gz"
          ]
      },
      "environmentYml": "dependencies:\r\n- pip:\r\n  - matplotlib==3.4.3"
  }
  

Αποστολή βιβλιοθηκών

Το API για την αποστολή βιβλιοθήκης προεργασίας δέχεται ένα αρχείο κάθε φορά. Οι υποστηριζόμενοι τύποι αρχείων είναι .whl, .jar, .tar.gz, .py και environment.yml για τη δημόσια βιβλιοθήκη. Μπορείτε να καθορίσετε το αρχείο μέσω του τύπου-περιεχομένου πολλαπλών τμηματικά/δεδομένων φόρμας.

• Δείγματα αιτήσεων

  POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries
  

Διαγραφή των βιβλιοθηκών

Καθορίζοντας το πλήρες όνομα του αρχείου βιβλιοθήκης με το επίθημα τύπου, μπορείτε να διαγράψετε μία βιβλιοθήκη κάθε φορά.

• Δείγματα αιτήσεων

  DELETE https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries?libraryToDelete=fuzzywuzzy-0.18.0-py2.py3-none-any.whl
  

Διαχείριση υπολογιστικού Spark προεργασίας

Μπορείτε να χρησιμοποιήσετε τον υπολογισμό spark προεργασίας ενημέρωσης για να διαχειριστείτε το υπολογιστικό αποτέλεσμα Spark.

Ελέγξτε το δημοσιευμένο Spark compute για το περιβάλλον

Πριν αλλάξετε τις ρυθμίσεις παραμέτρων για το περιβάλλον, μπορείτε να χρησιμοποιήσετε το API spark compute get published για να ελέγξετε ποιες ρυθμίσεις παραμέτρων υπολογισμού Spark είναι επί του παρόντος αποτελεσματικές.

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

  GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/sparkcompute
  

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

  {
      "instancePool": {
          "name": "Starter Pool",
          "type": "Workspace"
      },
      "driverCores": 4,
      "driverMemory": "56g",
      "executorCores": 4,
      "executorMemory": "56g",
      "dynamicExecutorAllocation": {
          "enabled": false,
          "minExecutors": 1,
          "maxExecutors": 1
      },
      "sparkProperties": {
          "spark.acls.enable": "false"
      },
      "runtimeVersion": "1.2"
  }
  

Ενημέρωση των υπολογιστικών ρυθμίσεων

Μπορείτε να ενημερώσετε τον χρόνο εκτέλεσης Spark, να μεταβείτε σε άλλο χώρο συγκέντρωσης, να περιορίσετε τις υπολογιστικές ρυθμίσεις και να προσθέσετε/καταργήσετε ιδιότητες Spark μέσω της επεξεργασίας του σώματος αίτησης αυτού του API.

Μπορείτε να αλλάξετε τον συνδεδεμένο χώρο συγκέντρωσης καθορίζοντας το όνομα και την ομάδα της πισίνας. Καθορίστε το όνομα του χώρου συγκέντρωσης ως Starter Pool για να αλλάξετε τον χώρο συγκέντρωσης στις προεπιλεγμένες ρυθμίσεις. Για να λάβετε την πλήρη λίστα των διαθέσιμων προσαρμοσμένων ομάδων του χώρου εργασίας κατά REST API, ανατρέξτε στο θέμα Προσαρμοσμένοι χώροι συγκέντρωσης - Λίστα Προσαρμοσμένων χώρων εργασίας

Εάν θέλετε να καταργήσετε μια υπάρχουσα ιδιότητα Spark, πρέπει να καθορίσετε την τιμή ως null με το κλειδί που θέλετε να καταργήσετε, όπως φαίνεται στο παρακάτω παράδειγμα.

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

  PATCH https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/sparkcompute
  
  {
      "instancePool": {
          "name": "Starter Pool",
          "type": "Workspace"
      },
      "driverCores": 4,
      "driverMemory": "56g",
      "executorCores": 4,
      "executorMemory": "56g",
      "dynamicExecutorAllocation": {
          "enabled": false,
          "minExecutors": 1,
          "maxExecutors": 1
      },
      "sparkProperties": {
          "spark.acls.enable": null
      },
      "runtimeVersion": "1.2"
  }
  

Καταστήστε τις αλλαγές αποτελεσματικές

Χρήση των παρακάτω συνόλων API για τη δημοσίευση των αλλαγών.

Προετοιμασία για δημοσίευση

Το περιβάλλον μπορεί να δέχεται μία δημοσίευση κάθε φορά. Πριν από τη δημοσίευση του περιβάλλοντός σας, μπορείτε να επικυρώσετε την κατάσταση του περιβάλλοντος και να εξετάσετε οριστικά τις αλλαγές προεργασίας. Όταν το περιβάλλον δημοσιευτεί με επιτυχία, όλες οι ρυθμίσεις παραμέτρων στην κατάσταση προεργασίας καθίστανται αποτελεσματικές.

• Βήμα 1: Λήψη των μετα-δεδομένων του περιβάλλοντος

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

  Στο σώμα της απόκρισης, μπορείτε να γνωρίζετε με σαφήνεια την κατάσταση του περιβάλλοντος. Βεβαιωθείτε ότι δεν υπάρχει συνεχής δημοσίευση προτού προχωρήσετε στο επόμενο βήμα.

• Βήμα 2: λάβετε τις βιβλιοθήκες προετοιμασίας/υπολογισμό Spark για να κάνετε μια τελική αναθεώρηση

  GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries
  
  GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/sparkcompute
  

Ενεργοποίηση της δημοσίευσης του περιβάλλοντος

Οι αλλαγές που κάνατε για τις βιβλιοθήκες προεργασίας και το spark compute αποθηκεύονται στο cache, αλλά απαιτούν τη δημοσίευση για να γίνουν αποτελεσματικές. Ακολουθήστε το παρακάτω παράδειγμα για να ενεργοποιήσετε τη δημοσίευση.

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

  POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/publish
  

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

  {
      "publishDetails":
      {
          "state": "Running",
          "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
          "startTime": "2024-03-29T14:17:09.0697022Z",
          "componentPublishInfo": {
              "sparkLibraries": {
                  "state": "Running"
              },
              "sparkSettings": {
                  "state": "Running"
              }
          }
      }
  }   
  

Κατά τη διάρκεια της δημοσίευσης, μπορείτε επίσης να καλέσετε το παρακάτω API για να το ακυρώσετε .

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

  POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/cancelPublish
  

Σχετικό περιεχόμενο

• Δημιουργήστε, ρυθμίστε τις παραμέτρους και χρησιμοποιήστε ένα περιβάλλον στο Microsoft Fabric.
• API στοιχείου - Περιβάλλον.