For the complete documentation index, see llms.txt. This page is also available as Markdown.

Instance

Field
Type
Description

id

string

(Read-only) The primary identifier for the instance.

extension

object

(Read-only) Represents the related extension.

version

string, core

Represents the version of the extension code that this instance is running, as reported by the instance itself.

meta

object

Represents the extensionMeta object which contains the extension metadata of the instance.

channel

object

(Read-only) Represents the channel object.

status

string, core

The status of the extension instance. Allowed values are:

  • Connecting

  • Running

  • Disconnected

  • Deleted

externalId

string

(Read-only) Identifier of the currently running instance. It must be logically unique for a given Extension (excluding Deleted instances).

audit

object

Represents the audit object.

Channel object

Field
Type
Description

identity

object

(Read‑only) Represents the Ziti identity.

Example

INSTANCE OBJECT
 {
    "id": "INS-1234-1234-0001",
    "extension": {
      "id": "EXT-6822-9898-4256",
      "href": "/extensions/EXT-6822-9898-4256",
      "name": "Microsoft AI Cloud Partner"
    },
    "status": "Running",
    "meta": {..},
    "channel": { }
    "externalId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
    "audit": {
      "created": { "at": "...", "by": { } },
      "updated": { "at": "...", "by": { } }
   }
 }

Last updated

Was this helpful?