Items - Get Operations Agent Definition

Service:: OperationsAgent

API Version:: v1

Returns the specified OperationsAgent public definition.

Note

OperationsAgent item is currently in Preview (learn more).

This API supports long running operations (LRO).

When you get a OperationsAgent's public definition, the sensitivity label is not a part of the definition.

Permissions

The caller must have read and write permissions for the OperationsAgent.

Required Delegated Scopes

Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	No

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/operationsAgents/{operationsAgentId}/getDefinition

With optional parameters:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/operationsAgents/{operationsAgentId}/getDefinition?format=OperationsAgentV1

URI Parameters

Name	In	Required	Type	Description
operationsAgentId	path	True	string (uuid)	The OperationsAgent ID.
workspaceId	path	True	string (uuid)	The workspace ID.
format	query		OperationsAgentDefinitionFormat	The format of the OperationsAgent public definition. Additional `format` types may be added over time.

Responses

Name	Type	Description
200 OK	OperationsAgentDefinitionResponse	Request completed successfully.
202 Accepted		Request accepted. Retrieving the definition is in progress. Headers Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests. Headers Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: OperationNotSupportedForItem - Operation not supported for requested item.

Examples

Get a OperationsAgent public definition example

Sample request

HTTP

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

Sample response

Status code:: 200

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

Status code:: 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

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
OperationsAgentDefinitionFormat	The format of the item definition. Additional `format` types may be added over time.
OperationsAgentDefinitionResponse	OperationsAgent public definition response.
OperationsAgentPublicDefinition	OperationsAgent public definition object. Refer to this article for more details on the structure of the OperationsAgent definition.
OperationsAgentPublicDefinitionPart	OperationsAgent definition part object.
PayloadType	The type of the definition part payload. Additional payload types may be added over time.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string (uuid)	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

OperationsAgentDefinitionFormat

Enumeration

The format of the item definition. Additional format types may be added over time.

Value	Description
OperationsAgentV1	The V1 JSON format for the OperationsAgent public definition, specifically designed to support CI/CD scenarios in Fabric. See OperationsAgent - OperationsAgentV1 specification for more details.

OperationsAgentDefinitionResponse

Object

OperationsAgent public definition response.

Name	Type	Description
definition	OperationsAgentPublicDefinition	OperationsAgent public definition object. Refer to this article for more details on the structure of the OperationsAgent definition.

OperationsAgentPublicDefinition

Object

OperationsAgent public definition object. Refer to this article for more details on the structure of the OperationsAgent definition.

Name	Type	Description
format	OperationsAgentDefinitionFormat	The format of the item definition. Additional `format` types may be added over time.
parts	OperationsAgentPublicDefinitionPart[]	A list of definition parts.

OperationsAgentPublicDefinitionPart

Object

OperationsAgent definition part object.

Name	Type	Description
path	string	The OperationsAgent public definition part path.
payload	string	The OperationsAgent public definition part payload.
payloadType	PayloadType	The payload type.

PayloadType

Enumeration

The type of the definition part payload. Additional payload types may be added over time.

Value	Description
InlineBase64	Inline Base 64.