Items - Update Data Pipeline Definition

Palvelu:: DataPipeline

Ohjelmointirajapinnan versio:: v1

Ohittaa määritetyn tietoputken määrityksen.
Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

DataPipelinen määrityksen päivittäminen ei vaikuta sen luottamuksellisuustunnistetta.

Käyttöoikeudet

Soittajalla on oltava tietoputken luku- ja kirjoitusoikeudet .

Vaaditut delegoidut vaikutusalueet

DataPipeline.ReadWrite.All tai Item.ReadWrite.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Rajapinta

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/updateDefinition

Valinnaisilla parametreilla:

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
dataPipelineId	path	True	string (uuid)	Tietoputken tunnus.
workspaceId	path	True	string (uuid)	Työtilan tunnus.
updateMetadata	query		boolean	Kun asetuksena on tosi ja .platform-tiedosto annetaan osana määritystä, kohteen metatiedot päivitetään käyttämällä .platform-tiedoston metatietoja.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Kuvaus
definition	True	DataPipelineDefinition	Tietoputken julkinen määritysobjekti. Katso tästä artikkelista lisätietoja tietoputken määrityksen rakenteesta.

Vastaukset

Nimi	Tyyppi	Kuvaus
200 OK		Pyynnön valmistuttua.
202 Accepted		Pyyntö hyväksytty. Päivitysmääritys on meneillään. Otsikot Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: OperationNotSupportedForItem – Toimintoa ei tueta pyydetylle kohteelle. VioittunutPayload – Annetut tiedot ovat vioittuneet.

Esimerkit

Update a data pipeline public definition example

Mallipyyntö

HTTP

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

{
  "definition": {
    "parts": [
      {
        "path": "pipeline-content.json",
        "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbCiAgICAgIHsKICAgICAgICAibmFtZSI6ICJXYWl0MSIsCiAgICAgICAgInR5cGUiOiAiV2FpdCIsCiAgICAgICAgImRlcGVuZHNPbiI6IFtdLAogICAgICAgICJ0eXBlUHJvcGVydGllcyI6IHsKICAgICAgICAgICJ3YWl0VGltZUluU2Vjb25kcyI6IDEKICAgICAgICB9CiAgICAgIH0KICAgIF0KICB9Cn0=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Mallivastaus

Tilakoodi:: 200

Tilakoodi:: 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

Määritelmät

Nimi	Kuvaus
DataPipelineDefinition	Tietoputken julkinen määritysobjekti. Katso tästä artikkelista lisätietoja tietoputken määrityksen rakenteesta.
DataPipelineDefinitionPart	Tietoputken määritelmäosan objekti.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
PayloadType	Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.
UpdateDataPipelineDefinitionRequest	Päivitä tietoputken julkisen määritelmän pyynnön tiedot.

DataPipelineDefinition

Kohde

Tietoputken julkinen määritysobjekti. Katso tästä artikkelista lisätietoja tietoputken määrityksen rakenteesta.

Nimi	Tyyppi	Kuvaus
format	string	Tietoputken määrityksen muoto.
parts	DataPipelineDefinitionPart[]	Luettelo määritysosista.

DataPipelineDefinitionPart

Kohde

Tietoputken määritelmäosan objekti.

Nimi	Tyyppi	Kuvaus
path	string	Tietoputken osan polku.
payload	string	Tietoputken osan hyötykuorma.
payloadType	PayloadType	Hyötykuorman tyyppi.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Kuvaus
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable	boolean	Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon `Retry-After` avulla, jos se on käytettävissä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

PayloadType

Luettelointi

Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
InlineBase64	Inline Base 64.

UpdateDataPipelineDefinitionRequest

Kohde

Päivitä tietoputken julkisen määritelmän pyynnön tiedot.

Nimi	Tyyppi	Kuvaus
definition	DataPipelineDefinition	Tietoputken julkinen määritysobjekti. Katso tästä artikkelista lisätietoja tietoputken määrityksen rakenteesta.