Items - Update Eventstream Definition

Υπηρεσία:: Eventstream

Έκδοση API:: v1

Ενημερώνει τον ορισμό μιας καθορισμένης ροής συμβάντων. Η ενημέρωση παρακάμπτει τον τρέχοντα ορισμό.
Αυτό το API υποστηρίζει λειτουργίες μεγάλης διάρκειας (LRO).

Η ενημέρωση του ορισμού eventstream, δεν επηρεάζει την ετικέτα ευαισθησίας του.

Δικαιώματα

Ο καλών πρέπει να έχει δικαιώματα ανάγνωσης και εγγραφής για το συμβάνstream.

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

Eventstream.ReadWrite.All ή Item.ReadWrite.All

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

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

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

Διασύνδεση

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition

Με προαιρετικές παραμέτρους:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition?updateMetadata={updateMetadata}

Παράμετροι URI

Όνομα	Σε	Απαιτείται	Τύπος	Περιγραφή
eventstreamId	path	True	string (uuid)	Το αναγνωριστικό eventstream.
workspaceId	path	True	string (uuid)	Το αναγνωριστικό χώρου εργασίας.
updateMetadata	query		boolean	Εάν θέλετε να ενημερώσετε τα μετα-δεδομένα του στοιχείου εάν παρέχεται στο `.platform` αρχείο. True - Ενημερώστε τα μετα-δεδομένα εάν παρέχονται στο `.platform` αρχείο ως μέρος του ορισμού, False - Μην ενημερώνετε τα μετα-δεδομένα.

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

Όνομα	Απαιτείται	Τύπος	Περιγραφή
definition	True	EventstreamDefinition	Αντικείμενο δημόσιου ορισμού Eventstream. Ανατρέξτε σε αυτό το άρθρο για περισσότερες λεπτομέρειες σχετικά με τη δομή του ορισμού Eventstream.

Αποκρίσεις

Όνομα	Τύπος	Περιγραφή
200 OK		Η αίτηση ολοκληρώθηκε με επιτυχία.
202 Accepted		Η αίτηση έγινε δεκτή. Ο ορισμός ενημέρωσης βρίσκεται σε εξέλιξη. Κεφαλίδες Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Έγινε υπέρβαση του ορίου επιτοκίου υπηρεσίας. Ο διακομιστής επιστρέφει μια `Retry-After` κεφαλίδα που υποδεικνύει, σε δευτερόλεπτα, πόσο πρέπει να περιμένει ο υπολογιστής-πελάτης πριν από την αποστολή πρόσθετων αιτήσεων. Κεφαλίδες Retry-After: integer
Other Status Codes	ErrorResponse	Συνήθεις κωδικοί σφαλμάτων: OperationNotSupportedForItem - Η λειτουργία δεν υποστηρίζεται για το στοιχείο που ζητήθηκε. CorruptedPayload - Το παρεχόμενο ωφέλιμο φορτίο είναι διεφθαρμένο.

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

Update an eventstream definition example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/eventstreams/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "eventstream.json",
        "payload": "SSdkIGxpa2UgdG8gdGVsbCBh..IGpva2UgZm9yIHlvdS4K",
        "payloadType": "InlineBase64"
      },
      {
        "path": "eventstreamProperties.json",
        "payload": "ewogICJyZXRlbnRpb25UaW1l..V2ZWwiOiAiTG93Igp9",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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

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

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

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Ορισμοί

Όνομα	Περιγραφή
ErrorRelatedResource	Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.
ErrorResponse	Η απόκριση σφάλματος.
ErrorResponseDetails	Οι λεπτομέρειες της απόκρισης σφάλματος.
EventstreamDefinition	Αντικείμενο δημόσιου ορισμού Eventstream. Ανατρέξτε σε αυτό το άρθρο για περισσότερες λεπτομέρειες σχετικά με τη δομή του ορισμού Eventstream.
EventstreamDefinitionPart	Αντικείμενο τμήματος ορισμού eventstream.
PayloadType	Ο τύπος του ωφέλιμου φορτίου τμήματος ορισμού. Επιπλέον τύποι ωφέλιμου φορτίου μπορούν να προστεθούν με την πάροδο του χρόνου.
UpdateEventstreamDefinitionRequest	Ενημερώστε το ωφέλιμο φορτίο αίτησης δημόσιου ορισμού eventstream.

ErrorRelatedResource

Αντικείμενο

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

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

ErrorResponse

Αντικείμενο

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

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

ErrorResponseDetails

Αντικείμενο

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

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

EventstreamDefinition

Αντικείμενο

Αντικείμενο δημόσιου ορισμού Eventstream. Ανατρέξτε σε αυτό το άρθρο για περισσότερες λεπτομέρειες σχετικά με τη δομή του ορισμού Eventstream.

Όνομα	Τύπος	Περιγραφή
format	string	Η μορφή του ορισμού eventstream.
parts	EventstreamDefinitionPart[]	Μια λίστα τμημάτων ορισμού.

EventstreamDefinitionPart

Αντικείμενο

Αντικείμενο τμήματος ορισμού eventstream.

Όνομα	Τύπος	Περιγραφή
path	string	Η διαδρομή τμήματος eventstream.
payload	string	Το ωφέλιμο φορτίο τμήματος eventstream.
payloadType	PayloadType	Ο τύπος ωφέλιμου φορτίου.

PayloadType

Απαρίθμηση

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

Τιμή	Περιγραφή
InlineBase64	Ενσωματωμένη βάση 64.

UpdateEventstreamDefinitionRequest

Αντικείμενο

Ενημερώστε το ωφέλιμο φορτίο αίτησης δημόσιου ορισμού eventstream.

Όνομα	Τύπος	Περιγραφή
definition	EventstreamDefinition	Αντικείμενο δημόσιου ορισμού Eventstream. Ανατρέξτε σε αυτό το άρθρο για περισσότερες λεπτομέρειες σχετικά με τη δομή του ορισμού Eventstream.