Microsoft Azure Assets API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Assets API
  description: Provides access to inventory assets.
schemes:
- https
tags:
- description: Provides access to inventory assets.
  name: Assets
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/assets:
    get:
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/OrderByParameter'
      - $ref: '#/parameters/SkipParameter'
      - $ref: '#/parameters/MaxPageSizeParameter'
      - in: query
        name: mark
        required: false
        type: string
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/AssetPageResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Assets
      operationId: microsoftAzureAssetsList
      summary: Microsoft Azure Retrieve A List Of Assets For The Provided Search Parameters
      x-ms-examples:
        Assets:
          $ref: ./examples/Assets_List.json
      x-ms-pageable:
        itemName: content
        nextLinkName: nextLink
      description: Needs a more full description created.
    patch:
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/FilterParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/AssetUpdateRequest'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/TaskResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Assets
      operationId: microsoftAzureAssetsUpdate
      summary: Microsoft Azure Update Labels On Assets Matching The Provided Filter
      x-ms-examples:
        Assets:
          $ref: ./examples/Assets_Update.json
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/assets/{assetId}:
    get:
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/AssetIdParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/AssetResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Assets
      operationId: microsoftAzureAssetsGet
      summary: Microsoft Azure Retrieve An Asset By Assetid
      x-ms-examples:
        Assets:
          $ref: ./examples/Assets_Get.json
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/assets/{assetId}/links:
    get:
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/AssetIdParameter'
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/SkipParameter'
      - $ref: '#/parameters/MaxPageSizeParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/AssetPageResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Assets
      operationId: microsoftAzureAssetsLinks
      summary: Microsoft Azure Retrieve Linked Asset Details For The Provided Assetid
      x-ms-examples:
        Assets:
          $ref: ./examples/Assets_Links.json
      x-ms-pageable:
        itemName: content
        nextLinkName: nextLink
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/assets:export:
    post:
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/FilterParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/TaskResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Assets
      operationId: microsoftAzureAssetsExport
      summary: Microsoft Azure Perform A Background Datasheet Export Of Assets Matching The Provided Filter  The Response Contains The Information Of The Running Export Task
      x-ms-examples:
        Assets:
          $ref: ./examples/Assets_Export.json
      description: Needs a more full description created.
  /assets:
    get:
      operationId: microsoftAzureAssetsListassetresource
      tags:
      - Assets
      description: Retrieve a list of assets for the provided search parameters.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/Azure.Core.FilterQueryParameter'
      - $ref: '#/parameters/OrderByParameter'
      - $ref: '#/parameters/Azure.Core.SkipQueryParameter'
      - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter'
      - $ref: '#/parameters/MarkParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedAssetResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Assets_ListAssetResource:
          $ref: ./examples/Assets_ListAssetResource_MaximumSet_Gen.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Assets
    post:
      operationId: microsoftAzureAssetsUpdateassets
      tags:
      - Assets
      description: Update labels on assets matching the provided filter.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/RequiredFilterParameter'
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/AssetUpdateData'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Task'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Assets_UpdateAssets:
          $ref: ./examples/Assets_UpdateAssets_MaximumSet_Gen.json
      summary: Microsoft Azure Post Assets
  /assets/{assetId}:
    get:
      operationId: microsoftAzureAssetsGetassetresource
      tags:
      - Assets
      description: Retrieve an asset by assetId.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: assetId
        in: path
        description: The system generated unique id for the resource.
        required: true
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/AssetResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Assets_GetAssetResource:
          $ref: ./examples/Assets_GetAssetResource_MaximumSet_Gen.json
      summary: Microsoft Azure Get Assets Assetid
  /subscriptions/{subscriptionId}/providers/Microsoft.DeviceRegistry/assets:
    get:
      operationId: microsoftAzureAssetsListbysubscription
      tags:
      - Assets
      description: List Asset resources by subscription ID
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/AssetListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List Assets in a Subscription.:
          $ref: ./examples/List_Assets_Subscription.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Deviceregistry Assets
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assets:
    get:
      operationId: microsoftAzureAssetsListbyresourcegroup
      tags:
      - Assets
      description: List Asset resources by resource group
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/AssetListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List Assets in a Resource Group.:
          $ref: ./examples/List_Assets_ResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceregistry Assets
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assets/{assetName}:
    get:
      operationId: microsoftAzureAssetsGet
      tags:
      - Assets
      description: Get a Asset
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: assetName
        in: path
        description: Asset name parameter.
        required: true
        type: string
        minLength: 3
        maxLength: 63
        pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/Asset'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get an Asset:
          $ref: ./examples/Get_Asset.json
        Get an Asset with Sync Status.:
          $ref: ./examples/Get_Asset_With_SyncStatus.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceregistry Assets Assetname
    put:
      operationId: microsoftAzureAssetsCreateorreplace
      tags:
      - Assets
      description: Create a Asset
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: assetName
        in: path
        description: Asset name parameter.
        required: true
        type: string
        minLength: 3
        maxLength: 63
        pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/Asset'
      responses:
        '200':
          description: Resource 'Asset' update operation succeeded
          schema:
            $ref: '#/definitions/Asset'
        '201':
          description: Resource 'Asset' create operation succeeded
          schema:
            $ref: '#/definitions/Asset'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create an Asset With External Asset Id.:
          $ref: ./examples/Create_Asset_With_ExternalAssetId.json
        Create an Asset Without Display Name.:
          $ref: ./examples/Create_Asset_Without_DisplayName.json
        Create an Asset Without External Asset Id.:
          $ref: ./examples/Create_Asset_Without_ExternalAssetId.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceregistry Assets Assetname
    patch:
      operationId: microsoftAzureAssetsUpdate
      tags:
      - Assets
      description: Update a Asset
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: assetName
        in: path
        description: Asset name parameter.
        required: true
        type: string
        minLength: 3
        maxLength: 63
        pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
      - name: properties
        in: body
        description: The resource properties to be updated.
        required: true
        schema:
          $ref: '#/definitions/AssetUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/Asset'
        '202':
          description: Resource update request accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Patch an Asset.:
          $ref: ./examples/Update_Asset.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceregistry Assets Assetname
    delete:
      operationId: microsoftAzureAssetsDelete
      tags:
      - Assets
      description: Delete a Asset
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: assetName
        in: path
        description: Asset name parameter.
        required: true
        type: string
        minLength: 3
        maxLength: 63
        pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete an Asset.:
          $ref: ./examples/Delete_Asset.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceregistry Assets Assetname
definitions:
  Azure.Core.uuid:
    type: string
    format: uuid
    description: Universally Unique Identifier
  AssetUpdateState:
    type: string
    description: The state to update the asset to.
    enum:
    - candidate
    - confirmed
    - dismissed
    - candidateInvestigate
    - associatedPartner
    - associatedThirdparty
    x-ms-enum:
      name: AssetUpdateState
      modelAsString: true
  AssetState:
    type: string
    description: The state of assets
    enum:
    - candidate
    - confirmed
    - dismissed
    - candidateInvestigate
    - associatedPartner
    - associatedThirdparty
    - archived
    x-ms-enum:
      name: AssetState
      modelAsString: true
  AssetUpdate:
    type: object
    description: The type used for update operations of the Asset.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/AssetUpdateProperties'
        x-ms-client-flatten: true
  ErrorDetail:
    description: This is the top-level error object whose code matches the x-ms-error-code response header
    properties:
      code:
        description: This is one of a server-defined set of error codes.
        type: string
      details:
        description: This is an array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/ErrorDetail'
        type: array
      innererror:
        $ref: '#/definitions/InnerError'
      message:
        description: This is a human-readable representation of the error.
        type: string
      target:
        description: This is the error target.
        type: string
    required:
    - code
    - message
    type: object
  LabelResource:
    properties:
      color:
        type: string
      displayName:
        type: string
      id:
        type: string
      name:
        type: string
      type:
        type: string
      uuid:
        type: string
    type: object
  AssetUpdateRequest:
    properties:
      externalId:
        type: string
      labels:
        $ref: '#/definitions/AssetLabelRequest'
      state:
        enum:
        - candidate
        - confirmed
        - dismissed
        - candidateInvestigate
        - associatedPartner
        - associatedThirdparty
        type: string
        x-ms-enum:
          modelAsString: true
          name: assetUpdateRequestState
    type: object
  AssetPageResponse:
    properties:
      content:
        items:
          $ref: '#/definitions/AssetResponse'
        type: array
      first:
        type: boolean
      last:
        type: boolean
      mark:
        type: string
      nextLink:
        type: string
      number:
        format: int32
        type: integer
      numberOfElements:
        format: int32
        type: integer
      size:
        format: int32
        type: integer
      totalElements:
        format: int64
        type: integer
      totalPages:
        format: int32
        type: integer
    type: object
  Event:
    type: object
    description: Defines the event properties.
    properties:
      name:
        type: string
        description: The name of the event.
      eventNotifier:
        type: string
        description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset.
      capabilityId:
        type: string
        description: The path to the type definition of the capability (e.g. DTMI, OPC UA information model node id, etc.), for example dtmi:com:example:Robot:_contents:__prop1;1.
      observabilityMode:
        type: string
        description: An indication of how the event should be mapped to OpenTelemetry.
        default: none
        enum:
        - none
        - log
        x-ms-enum:
          name: EventsObservabilityMode
          modelAsString: true
          values:
          - name: None
            value: none
            description: No mapping to OpenTelemetry.
          - name: Log
            value: log
            description: Map as log to OpenTelemetry.
      eventConfiguration:
        type: string
        description: Protocol-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.
    required:
    - eventNotifier
  AuditTrailItem:
    properties:
      displayName:
        type: string
      id:
        type: string
      kind:
        enum:
        - as
        - contact
        - domain
        - host
        - ipAddress
        - ipBlock
        - page
        - sslCert
        type: string
        x-ms-enum:
          modelAsString: true
          name: auditTrailItemKind
      name:
        type: string
      reason:
        type: string
    type: object
  AssetResource:
    type: object
    description: The items in the current page of results.
    properties:
      kind:
        type: string
        description: Discriminator property for AssetResource.
      id:
        type: string
        description: The system generated unique id for the resource.
        readOnly: true
      name:
        type: string
        description: The caller provided unique name for the resource.
      displayName:
        type: string
        description: The name that can be used for display purposes.
      uuid:
        $ref: '#/definitions/Azure.Core.uuid'
        description: Global UUID for the asset.
      createdDate:
        type: string
        format: date-time
        description: The date this asset was first added to this workspace.
      updatedDate:
        type: string
        format: date-time
        description: The date this asset was last updated for this workspace.
      state:
        $ref: '#/definitions/AssetState'
      externalId:
        type: string
        description: An optional customer provided identifier for this asset.
      labels:
        type: array
        description: Customer labels assigned to this asset.
        items:
          type: string
      wildcard:
        type: boolean
        description: An indicator of whether this asset represents a wildcard rollup of assets on this domain.
      discoGroupName:
        type: string
        description: The name of the DiscoGroup that brought added this asset to the workspace.
      auditTrail:
        type: array
        description: The history of how this asset was pulled into the workspace through the discovery process.
        items:
          $ref: '#/definitions/AuditTrailItem_2'
      reason:
        type: string
    discriminator: kind
    required:
    - kind
    - id
  AssetProperties:
    type: object
    description: Defines the asset properties.
    properties:
      uuid:
        type: string
        description: Globally unique, immutable, non-reusable id.
        readOnly: true
      assetType:
        type: string
        description: Resource path to asset type (model) definition.
      enabled:
        type: boolean
        description: Enabled/Disabled status of the asset.
      externalAssetId:
        type: string
        description: Asset id provided by the customer.
        x-ms-mutability:
        - read
        - create
      displayName:
        type: string
        description: Human-readable display name.
      description:
        type: string
        description: Human-readable description of the asset.
      assetEndpointProfileUri:
        type: string
        description: A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must have the format <ModuleCR.metadata.namespace>/<ModuleCR.metadata.name>.
        x-ms-mutability:
        - read
        - create
      version:
        type: integer
        format: int32
        description: An integer that is incremented each time the resource is modified.
        readOnly: true
      manufacturer:
        type: string
        description: Asset manufacturer name.
      manufacturerUri:
        type: string
        description: Asset manufacturer URI.
      model:
        type: string
        description: Asset model name.
      productCode:
        type: string
        description: Asset product code.
      hardwareRevision:
        type: string
        description: Revision number of the hardware.
      softwareRevision:
        type: string
        description: Revision number of the software.
      documentationUri:
        type: string
        description: Reference to the documentation.
      serialNumber:
        type: string
        description: Asset serial number.
      attributes:
        type: object
        description: A set of key-value pairs that contain custom attributes set by the customer.
        additionalProperties: {}
      defaultDataPointsConfiguration:
        type: string
        description: Protocol-specific default configuration for all data points. Each data point can have its own configuration that overrides the default settings here. This assumes that each asset instance has one protocol.
      defaultEventsConfiguration:
        type: string
        description: Protocol-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. This assumes that each asset instance has one protocol.
      dataPoints:
        type: array
        description: Array of data points that are part of the asset. Each data point can reference an asset type capability and have per-data point configuration. See below for more details for the definition of the dataPoints element.
        items:
          $ref: '#/definitions/DataPoint'
        x-ms-identifiers: []
      events:
        type: array
        description: Array of events that are part of the asset. Each event can reference an asset type capability and have per-event configuration. See below for more details about the definition of the events element.
        items:
          $ref: '#/definitions/Event'
        x-ms-identifiers: []
      status:
        $ref: '#/definitions/AssetStatus'
        description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
        readOnly: true
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: Provisioning state of the resource.
        readOnly: true
    required:
    - assetEndpointProfileUri
  ExtendedLocation:
    type: object
    description: The extended location.
    properties:
      type:
        type: string
        description: The extended location type.
      name:
        type: string
        description: The extended location name.
    required:
    - type
    - name
  TaskResponse:
    properties:
      completedAt:
        format: date-time
        type: string
      id:
        type: string
      lastPolledAt:
        format: date-time
        type: string
      phase:
        enum:
        - running
        - polling
        - complete
        type: string
        x-ms-enum:
          modelAsString: true
          name: taskResponsePhase
      reason:
        type: string
      startedAt:
        format: date-time
        type: string
      state:
        enum:
        - pending
        - running
        - paused
        - complete
        - incomplete
        - failed
        - warning
        type: string
        x-ms-enum:
          modelAsString: true
          name: taskResponseState
    type: object
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
  AssetUpdateData:
    type: object
    description: A request body used to update an asset.
    properties:
      state:
        $ref: '#/definitions/AssetUpdateState'
        description: The state to update the asset to.
      externalId:
        type: string
        description: A string which can be used to identify the asset in external systems.
      labels:
        type: object
        descriptio

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-assets-api-openapi.yml