Items - Publish Data Agent

Tjeneste:
DataAgent
API-versjon:
v1

Publiserer konfigurasjonen for oppsamling av den angitte DataAgent.

Obs!

Konfigurasjonsbehandling for dataagent er for øyeblikket i forhåndsvisning (finn ut mer).

Fremmer gjeldende oppsamlingstilstand til det publiserte miljøet, noe som gjør det live.

Tillatelser

Innringeren må ha lese- og skrivetillatelser for DataAgent.

Nødvendige delegerte omfang

Item.ReadWrite.All eller DataAgent.ReadWrite.All

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft identiteter oppført i denne delen.

Identity Kundestøtte
Bruker Ja
tjenestekontohaver og administrerte identiteter Ja

Grensesnitt

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

URI-parametere

Navn I Obligatorisk Type Beskrivelse
dataAgentId
 path True

string (uuid)

DataAgent-ID-en.
workspaceId
 path True

string (uuid)

Arbeidsområde-ID-en.

Brødtekst for forespørsel

Navn Type Beskrivelse
publishedDescription

string

En beskrivelse som vises når agenten vises i andre opplevelser.

Svar

Navn Type Beskrivelse
200 OK

PublishDataAgentResponse

Forespørselen er fullført.
429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • ItemNotFound – Finner ikke det forespurte elementet.

  • InvalidRequest – ugyldig forespørsel.

Eksempler

Publish DataAgent example

Eksempelforespørsel

POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataAgents/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/publish

{
  "publishedDescription": "Production release v2 with improved instructions"
}

Eksempelsvar

Statuskode:
200 
{
  "publishedDescription": "Production release v2 with improved instructions"
}

Definisjoner

Navn Beskrivelse
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
PublishDataAgentRequest

Publiser nyttelast for DataAgent-forespørsel.
PublishDataAgentResponse

Publiser DataAgent-svar.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable

boolean

Når sann, kan forespørselen prøves på nytt. Retry-After Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string (uuid)

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

PublishDataAgentRequest

Objekt

Publiser nyttelast for DataAgent-forespørsel.

Navn Type Beskrivelse
publishedDescription

string

En beskrivelse som vises når agenten vises i andre opplevelser.

PublishDataAgentResponse

Objekt

Publiser DataAgent-svar.

Navn Type Beskrivelse
publishedDescription

string

Publiseringsbeskrivelsen.