Items - Get Eventstream Definition

Service:

Eventstream

API-versie:

v1

Retourneert de opgegeven openbare definitie van eventstream.
Deze API ondersteunt langlopende bewerkingen (LRO).

Wanneer u een openbare definitie van eventstream krijgt, maakt het vertrouwelijkheidslabel geen deel uit van de definitie.

Machtigingen

De aanroeper moet lees- en schrijfmachtigingen hebben voor de eventstream.

Vereiste gedelegeerde bereiken

Eventstream.ReadWrite.All of Item.ReadWrite.All

Beperkingen

Deze API wordt geblokkeerd voor een eventstream met een versleuteld vertrouwelijkheidslabel.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit	Ondersteuning
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Ja

gebruikersinterface

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
eventstreamId	path	True	string (uuid)	De evenementenstroom-id.
workspaceId	path	True	string (uuid)	De werkruimte-ID.
format	query		string	De indeling van de openbare definitie van eventstream.

Antwoorden

Name	Type	Description
200 OK	EventstreamDefinitionResponse	De aanvraag is voltooid.
202 Accepted		Aanvraag geaccepteerd. Het ophalen van de definitie wordt uitgevoerd. Kopteksten Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: OperationNotSupportedForItem - Bewerking wordt niet ondersteund voor aangevraagd item.

Voorbeelden

Get an eventstream definition example

Voorbeeldaanvraag

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/eventstreams/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Voorbeeldrespons

Statuscode:

200

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

Statuscode:

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definities

Name	Description
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
EventstreamDefinition	Eventstream-object voor openbare definitie.
EventstreamDefinitionPart	Eventstream-definitieonderdeelobject.
EventstreamDefinitionResponse	Antwoord van openbare definitie eventstream.
PayloadType	Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

EventstreamDefinition

Object

Eventstream-object voor openbare definitie.

Name	Type	Description
format	string	De indeling van de itemdefinitie.
parts	EventstreamDefinitionPart[]	Een lijst met definitieonderdelen.

EventstreamDefinitionPart

Object

Eventstream-definitieonderdeelobject.

Name	Type	Description
path	string	Het pad van het eventstream-onderdeel.
payload	string	De nettolading van het eventstream-onderdeel.
payloadType	PayloadType	Het nettoladingstype.

EventstreamDefinitionResponse

Object

Antwoord van openbare definitie eventstream.

Name	Type	Description
definition	EventstreamDefinition	Eventstream-object voor openbare definitie.

PayloadType

Inventarisatie

Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

Waarde	Description
InlineBase64	Inline base 64.