Table of Contents

Namespace Azure.Iot.Operations.Services.EdgeRegistry.Generated

Namespaces

Azure.Iot.Operations.Services.EdgeRegistry.Generated.Common

Classes

Constants

Global constants.

CreateGroupResponseSchema

The Group entity.

CreateResourceRequestPayload

Request payload for creating a generic xRegistry Resource entity along with its default Version.

CreateResourceResponseSchema

The Resource entity.

CreateSchemaVersionAttributes

Request payload for creating a Schema Version.

CreateSchemaVersionResponseSchema

The Schema Version entity.

CreateThingDescriptionVersionAttributes

Request payload for creating a Thing Description Version.

CreateThingDescriptionVersionResponseSchema

The Thing Description Version entity.

CreateThingModelVersionAttributes

Request payload for creating a Thing Model Version.

CreateThingModelVersionResponseSchema

The Thing Model Version entity.

CreateVersionRequestPayload

Request payload for creating a generic xRegistry Version entity. The parent Resource is implicitly created if it doesn't already exist. Create is strictly idempotent: if every field matches the latest Version of the parent Resource (including labels), the latest Version is returned; otherwise a new Version is created.

CreateVersionResponseSchema

The created or matching existing Version entity.

DeleteGroupResponseSchema

Response to a 'deleteGroup' Action.

DeleteOptions

Options that control the behavior of a delete operation.

DeleteRequestPayload

Request payload for deleting an xRegistry entity.

DeleteResourceResponseSchema

Response to a 'deleteResource' Action.

DeleteSchemaVersionResponseSchema

Response to a 'deleteSchemaVersion' Action.

DeleteThingDescriptionVersionResponseSchema

Response to a 'deleteThingDescriptionVersion' Action.

DeleteThingModelVersionResponseSchema

Response to a 'deleteThingModelVersion' Action.

DeleteVersionResponseSchema

Response to a 'deleteVersion' Action.

DeprecatedInfo

Information about the deprecation status of an entity.

EdgeRegistry
EdgeRegistry.Client
EdgeRegistry.CreateGroupActionInvoker

Specializes the CommandInvoker class for Command 'createGroup'.

EdgeRegistry.CreateResourceActionInvoker

Specializes the CommandInvoker class for Command 'createResource'.

EdgeRegistry.CreateVersionActionInvoker

Specializes the CommandInvoker class for Command 'createVersion'.

EdgeRegistry.DeleteGroupActionInvoker

Specializes the CommandInvoker class for Command 'deleteGroup'.

EdgeRegistry.DeleteResourceActionInvoker

Specializes the CommandInvoker class for Command 'deleteResource'.

EdgeRegistry.DeleteVersionActionInvoker

Specializes the CommandInvoker class for Command 'deleteVersion'.

EdgeRegistry.GetGroupActionInvoker

Specializes the CommandInvoker class for Command 'getGroup'.

EdgeRegistry.GetResourceActionInvoker

Specializes the CommandInvoker class for Command 'getResource'.

EdgeRegistry.GetVersionActionInvoker

Specializes the CommandInvoker class for Command 'getVersion'.

EdgeRegistry.ListGroupsActionInvoker

Specializes the CommandInvoker class for Command 'listGroups'.

EdgeRegistry.ListResourcesActionInvoker

Specializes the CommandInvoker class for Command 'listResources'.

EdgeRegistry.ListVersionsActionInvoker

Specializes the CommandInvoker class for Command 'listVersions'.

EdgeRegistryError
EdgeRegistryErrorException
EdgeRegistrySchemaExtensions
EdgeRegistrySchemaExtensions.Client
EdgeRegistrySchemaExtensions.CreateSchemaVersionActionInvoker

Specializes the CommandInvoker class for Command 'createSchemaVersion'.

EdgeRegistrySchemaExtensions.DeleteSchemaVersionActionInvoker

Specializes the CommandInvoker class for Command 'deleteSchemaVersion'.

EdgeRegistrySchemaExtensions.GetSchemaVersionActionInvoker

Specializes the CommandInvoker class for Command 'getSchemaVersion'.

EdgeRegistrySchemaExtensions.ListSchemaVersionsActionInvoker

Specializes the CommandInvoker class for Command 'listSchemaVersions'.

EdgeRegistryThingDescriptionExtensions
EdgeRegistryThingDescriptionExtensions.Client
EdgeRegistryThingDescriptionExtensions.CreateThingDescriptionVersionActionInvoker

Specializes the CommandInvoker class for Command 'createThingDescriptionVersion'.

EdgeRegistryThingDescriptionExtensions.DeleteThingDescriptionVersionActionInvoker

Specializes the CommandInvoker class for Command 'deleteThingDescriptionVersion'.

EdgeRegistryThingDescriptionExtensions.GetThingDescriptionVersionActionInvoker

Specializes the CommandInvoker class for Command 'getThingDescriptionVersion'.

EdgeRegistryThingDescriptionExtensions.ListThingDescriptionVersionsActionInvoker

Specializes the CommandInvoker class for Command 'listThingDescriptionVersions'.

EdgeRegistryThingModelExtensions
EdgeRegistryThingModelExtensions.Client
EdgeRegistryThingModelExtensions.CreateThingModelVersionActionInvoker

Specializes the CommandInvoker class for Command 'createThingModelVersion'.

EdgeRegistryThingModelExtensions.DeleteThingModelVersionActionInvoker

Specializes the CommandInvoker class for Command 'deleteThingModelVersion'.

EdgeRegistryThingModelExtensions.GetThingModelVersionActionInvoker

Specializes the CommandInvoker class for Command 'getThingModelVersion'.

EdgeRegistryThingModelExtensions.ListThingModelVersionsActionInvoker

Specializes the CommandInvoker class for Command 'listThingModelVersions'.

GetGroupInputArguments

Input arguments for action 'getGroup'

GetGroupResponseSchema

The Group entity.

GetResourceInputArguments

Input arguments for action 'getResource'

GetResourceResponseSchema

The Resource entity.

GetSchemaVersionInputArguments

Input arguments for action 'getSchemaVersion'

GetSchemaVersionResponseSchema

The Schema Version entity.

GetThingDescriptionVersionInputArguments

Input arguments for action 'getThingDescriptionVersion'

GetThingDescriptionVersionResponseSchema

The Thing Description Version entity.

GetThingModelVersionInputArguments

Input arguments for action 'getThingModelVersion'

GetThingModelVersionResponseSchema

The Thing Model Version entity.

GetVersionInputArguments

Input arguments for action 'getVersion'

GetVersionResponseSchema

The Version entity.

Group

A Group entity — container for related Resources.

GroupAttributes

Request payload for creating or updating a Group.

Label

A key-value pair used for labeling.

ListGroupsOutputArguments

List of Group identifiers.

ListGroupsResponseSchema

List of Group identifiers.

ListResourcesRequestPayload

Request payload for listing xRegistry Resources, optionally filtered by Group type, Group, Resource type, and/or label.

ListResourcesResponseSchema

List of Resource XIDs matching the provided constraints.

ListSchemaVersionsResponseSchema

List of Schema Version XIDs matching the provided constraints.

ListThingDescriptionVersionsResponseSchema

List of Thing Description Version XIDs matching the provided constraints.

ListThingModelVersionsResponseSchema

List of Thing Model Version XIDs matching the provided constraints.

ListVersionsRequestPayload

Request payload for listing xRegistry Versions, optionally filtered by Group type, Group, Resource type, Resource, and/or label.

ListVersionsResponseSchema

List of Version XIDs matching the provided constraints.

Resource

Resource entity

ResourceMeta
ResourceMetaAttributes

Mutable attributes for creating or updating a Resource (its meta sub-entity).

ResourceXid

The XID components that identify a Resource.

ResourceXidList

List of Resource XIDs within the provided constraints with the specified label.

SchemaExtensionError
SchemaExtensionErrorException
SchemaFormat

Non-exhaustive supported schema formats

SchemaVersion

A specific Version of a Schema. Self-contained: combines the generic Version fields and the schema-specific fields into one schema, with integer-typed versionId and ancestor.

SchemaVersionXid

The XID components that identify a Schema Version.

SchemaVersionXidList

List of Schema Version XIDs within the provided constraints with the specified label.

ThingDescriptionExtensionError
ThingDescriptionExtensionErrorException
ThingDescriptionFormat

Non-exhaustive supported WoT TD formats

ThingDescriptionVersion

A specific Version of a Thing Description. Self-contained: combines the generic Version fields and the thing description-specific fields into one schema, with integer-typed versionId and ancestor.

ThingDescriptionVersionXid

The XID components that identify a Thing Description Version.

ThingDescriptionVersionXidList

List of Thing Description Version XIDs within the provided constraints with the specified label.

ThingModelExtensionError
ThingModelExtensionErrorException
ThingModelFormat

Non-exhaustive supported WoT TM formats

ThingModelVersion

A specific Version of a Thing Model. Self-contained: combines the generic Version fields and the thing model-specific fields into one schema, with integer-typed versionId and ancestor.

ThingModelVersionXid

The XID components that identify a Thing Model Version.

ThingModelVersionXidList

List of Thing Model Version XIDs within the provided constraints with the specified label.

ValidationStatus

Indicates whether validation was performed, and if not, the reason why not (e.g., "unsupported format", "validation disabled").

Version

A specific Version of a Resource.

VersionAttributes

Attributes needed to create a Version.

VersionXid

The XID components that identify a Version.

VersionXidList

List of Version XIDs within the provided constraints with the specified label.