Items - Get Spark Job Definition Definition

Tjeneste:

SparkJobDefinition

API-version:

v1

Returnerer den angivne offentlige definition af sparkjobbet.
Denne API understøtter LRO-handlinger (Long Running Operations).

Når du får vist en offentlig definition af en sparkjobdefinition, er følsomhedsmærkaten ikke en del af definitionen.

Tilladelser

Kalderen skal have læse- og skrivetilladelser til definitionen af spark-job.

Påkrævede delegerede områder

SparkJobDefinition.ReadWrite.All eller Item.ReadWrite.All

Begrænsninger

Denne API er blokeret for en spark jobdefinition med en krypteret følsomhedsmærkat.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Brugergrænseflade

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/getDefinition

Med valgfrie parametre:

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
sparkJobDefinitionId	path	True	string (uuid)	Definitions-id'et for sparkjobbet.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
format	query		string	Formatet for definitionen af den offentlige definition af sparkjobbet.

Svar

Name	Type	Beskrivelse
200 OK	SparkJobDefinitionDefinitionResponse	Anmodningen blev fuldført.
202 Accepted		Anmodningen blev accepteret. Hentning af definitionen er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: OperationNotSupportedForItem – Handlingen understøttes ikke for det ønskede element.

Eksempler

Get a spark job definition public definition example

Eksempelanmodning

HTTP

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

Eksempelsvar

Statuskode:

200

{
  "definition": {
    "parts": [
      {
        "path": "SparkJobDefinitionV1.json",
        "payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Statuskode:

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

Definitioner

Name	Beskrivelse
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.
SparkJobDefinitionDefinitionResponse	Spark jobdefinitionssvar til offentlig definition.
SparkJobDefinitionPublicDefinition	Spark-jobdefinitionsobjekt for offentlig definition. Se denne artikel for at få flere oplysninger om, hvordan du udformer en offentlig definition af et sparkjob.
SparkJobDefinitionPublicDefinitionPart	Spark jobdefinitionsdelobjekt.

ErrorRelatedResource

Object

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Object

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Object

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.

SparkJobDefinitionDefinitionResponse

Object

Spark jobdefinitionssvar til offentlig definition.

Name	Type	Beskrivelse
definition	SparkJobDefinitionPublicDefinition	Spark-jobdefinitionsobjekt for offentlig definition. Se denne artikel for at få flere oplysninger om, hvordan du udformer en offentlig definition af et sparkjob.

SparkJobDefinitionPublicDefinition

Object

Spark-jobdefinitionsobjekt for offentlig definition. Se denne artikel for at få flere oplysninger om, hvordan du udformer en offentlig definition af et sparkjob.

Name	Type	Beskrivelse
format	string	Formatet af elementdefinitionen. Understøttet format: SparkJobDefinitionV1.
parts	SparkJobDefinitionPublicDefinitionPart[]	En liste over definitionsdele.

SparkJobDefinitionPublicDefinitionPart

Object

Spark jobdefinitionsdelobjekt.

Name	Type	Beskrivelse
path	string	Stien til den offentlige definition af definitionen af sparkjobbet.
payload	string	Nyttedata for definitionen af den offentlige definition af sparkjobbet.
payloadType	PayloadType	Nyttedatatypen.