Discovered Assets - List By Subscription

Tjänst:

Device Registry

API-version:

2024-09-01-preview

Lista DiscoveredAsset-resurser efter prenumerations-ID

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DeviceRegistry/discoveredAssets?api-version=2024-09-01-preview

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	DiscoveredAssetListResult	Azure-åtgärden har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

List_DiscoveredAssets_Subscription

Exempelbegäran

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DeviceRegistry/discoveredAssets?api-version=2024-09-01-preview

Java

/**
 * Samples for DiscoveredAssets List.
 */
public final class Main {
    /*
     * x-ms-original-file: 2024-09-01-preview/List_DiscoveredAssets_Subscription.json
     */
    /**
     * Sample code: List_DiscoveredAssets_Subscription.
     * 
     * @param manager Entry point to DeviceRegistryManager.
     */
    public static void
        listDiscoveredAssetsSubscription(com.azure.resourcemanager.deviceregistry.DeviceRegistryManager manager) {
        manager.discoveredAssets().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.deviceregistry import DeviceRegistryMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-deviceregistry
# USAGE
    python list_discovered_assets_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DeviceRegistryMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.discovered_assets.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: 2024-09-01-preview/List_DiscoveredAssets_Subscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DeviceRegistryManagementClient } = require("@azure/arm-deviceregistry");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to list DiscoveredAsset resources by subscription ID
 *
 * @summary list DiscoveredAsset resources by subscription ID
 * x-ms-original-file: 2024-09-01-preview/List_DiscoveredAssets_Subscription.json
 */
async function listDiscoveredAssetsSubscription() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new DeviceRegistryManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.discoveredAssets.listBySubscription()) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.DeviceRegistry;

// Generated from example definition: 2024-09-01-preview/List_DiscoveredAssets_Subscription.json
// this example is just showing the usage of "DiscoveredAsset_ListBySubscription" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (DeviceRegistryDiscoveredAssetResource item in subscriptionResource.GetDeviceRegistryDiscoveredAssetsAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    DeviceRegistryDiscoveredAssetData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exempelsvar

Statuskod:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DeviceRegistry/discoveredAssets/my-discoveredasset",
      "name": "my-asset",
      "type": "Microsoft.DeviceRegistry/discoveredAssets",
      "location": "West Europe",
      "extendedLocation": {
        "type": "CustomLocation",
        "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1"
      },
      "tags": {
        "site": "building-1"
      },
      "systemData": {
        "createdBy": "2ta23112-4596-44ff-b773-19405922bfc1",
        "createdByType": "Application",
        "createdAt": "2022-11-16T00:36:43.2516899Z",
        "lastModifiedBy": "2ta23112-4596-44ff-b773-19405922bfc1",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2022-11-16T01:37:16.0922793Z"
      },
      "properties": {
        "assetEndpointProfileRef": "myAssetEndpointProfile",
        "discoveryId": "11111111-1111-1111-1111-111111111111",
        "version": 73766,
        "manufacturer": "Contoso",
        "manufacturerUri": "https://www.contoso.com/manufacturerUri",
        "model": "ContosoModel",
        "productCode": "SA34VDG",
        "hardwareRevision": "1.0",
        "softwareRevision": "2.0",
        "documentationUri": "https://www.example.com/manual",
        "serialNumber": "64-103816-519918-8",
        "defaultDatasetsConfiguration": "{\"publishingInterval\":10,\"samplingInterval\":15,\"queueSize\":20}",
        "defaultTopic": {
          "path": "/path/defaultTopic",
          "retain": "Keep"
        },
        "datasets": [
          {
            "name": "dataset1",
            "datasetConfiguration": "{\"publishingInterval\":10,\"samplingInterval\":15,\"queueSize\":20}",
            "topic": {
              "path": "/path/dataset1",
              "retain": "Keep"
            },
            "dataPoints": [
              {
                "name": "dataPoint1",
                "dataSource": "nsu=http://microsoft.com/Opc/OpcPlc/;s=FastUInt1",
                "lastUpdatedOn": "2024-04-09T14:20:00.52Z"
              },
              {
                "name": "dataPoint2",
                "dataSource": "nsu=http://microsoft.com/Opc/OpcPlc/;s=FastUInt2",
                "lastUpdatedOn": "2024-04-09T14:20:00.52Z"
              }
            ]
          }
        ],
        "events": [
          {
            "name": "event1",
            "eventNotifier": "nsu=http://microsoft.com/Opc/OpcPlc/;s=FastUInt3",
            "topic": {
              "path": "/path/event1",
              "retain": "Keep"
            },
            "lastUpdatedOn": "2024-04-09T14:20:00.52Z"
          },
          {
            "name": "event2",
            "eventNotifier": "nsu=http://microsoft.com/Opc/OpcPlc/;s=FastUInt4",
            "lastUpdatedOn": "2024-04-09T14:20:00.52Z"
          }
        ],
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DeviceRegistry/discoveredAssets/my-discoveredasset1",
      "name": "my-asset1",
      "type": "Microsoft.DeviceRegistry/discoveredAssets",
      "location": "West Europe",
      "extendedLocation": {
        "type": "CustomLocation",
        "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1"
      },
      "tags": {
        "site": "building-2"
      },
      "systemData": {
        "createdBy": "2ta23112-4596-44ff-b773-19405922bfc1",
        "createdByType": "Application",
        "createdAt": "2022-11-16T00:36:43.2516899Z",
        "lastModifiedBy": "2ta23112-4596-44ff-b773-19405922bfc1",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2022-11-16T01:37:16.0922793Z"
      },
      "properties": {
        "assetEndpointProfileRef": "myAssetEndpointProfile",
        "discoveryId": "11111111-1111-1111-1111-111111111111",
        "version": 73766,
        "manufacturer": "Contoso",
        "manufacturerUri": "https://www.contoso.com/manufacturerUri",
        "model": "ContosoModel",
        "productCode": "SA34VDG",
        "hardwareRevision": "1.0",
        "softwareRevision": "2.0",
        "documentationUri": "https://www.example.com/manual",
        "serialNumber": "64-103816-519918-8",
        "defaultDatasetsConfiguration": "{\"publishingInterval\":10,\"samplingInterval\":15,\"queueSize\":20}",
        "defaultTopic": {
          "path": "/path/defaultTopic",
          "retain": "Keep"
        },
        "datasets": [
          {
            "name": "dataset1",
            "datasetConfiguration": "{\"publishingInterval\":10,\"samplingInterval\":15,\"queueSize\":20}",
            "topic": {
              "path": "/path/dataset1",
              "retain": "Keep"
            },
            "dataPoints": [
              {
                "name": "dataPoint1",
                "dataSource": "nsu=http://microsoft.com/Opc/OpcPlc/;s=FastUInt1",
                "lastUpdatedOn": "2024-04-09T14:20:00.52Z"
              },
              {
                "name": "dataPoint2",
                "dataSource": "nsu=http://microsoft.com/Opc/OpcPlc/;s=FastUInt2",
                "lastUpdatedOn": "2024-04-09T14:20:00.52Z"
              }
            ]
          }
        ],
        "events": [
          {
            "name": "event1",
            "eventNotifier": "nsu=http://microsoft.com/Opc/OpcPlc/;s=FastUInt3",
            "topic": {
              "path": "/path/event1",
              "retain": "Keep"
            },
            "lastUpdatedOn": "2024-04-09T14:20:00.52Z"
          },
          {
            "name": "event2",
            "eventNotifier": "nsu=http://microsoft.com/Opc/OpcPlc/;s=FastUInt4",
            "lastUpdatedOn": "2024-04-09T14:20:00.52Z"
          }
        ],
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
DiscoveredAsset	Identifierad tillgångsdefinition.
DiscoveredAssetListResult	Svaret från en DiscoveredAsset-liståtgärd.
DiscoveredDataPoint	Definierar datapunktsegenskaperna.
DiscoveredDataset	Definierar egenskaperna för datamängden.
DiscoveredEvent	Definierar händelseegenskaperna.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ExtendedLocation	Den utökade platsen.
ProvisioningState	Resursens etableringsstatus.
systemData	Metadata som rör skapande och senaste ändring av resursen.
Topic	Objekt som beskriver ämnesinformationen.
TopicRetainType	När det är inställt på "Behåll" har meddelanden som publicerats till en MQTT-asynkron meddelandekö kvarhållningsflaggan inställd. Standard: "Aldrig".

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
Application
Key
ManagedIdentity
User

DiscoveredAsset

Objekt

Identifierad tillgångsdefinition.

Name	Typ	Description
extendedLocation	ExtendedLocation	Den utökade platsen.
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.assetEndpointProfileRef	string	En referens till den tillgångsslutpunktsprofil (anslutningsinformation) som används av koordinatorer för att ansluta till en slutpunkt som tillhandahåller datapunkter för den här tillgången. Måste ange namnet på tillgångsslutpunktens profil.
properties.datasets	DiscoveredDataset[]	Matris med datauppsättningar som är en del av tillgången. Varje datamängdsspecifikation beskriver de datapunkter som utgör uppsättningen.
properties.defaultDatasetsConfiguration	string	Strängifierad JSON som innehåller anslutningsspecifik standardkonfiguration för alla datauppsättningar. Varje datauppsättning kan ha en egen konfiguration som åsidosätter standardinställningarna här.
properties.defaultEventsConfiguration	string	Strängifierad JSON som innehåller anslutningsspecifik standardkonfiguration för alla händelser. Varje händelse kan ha en egen konfiguration som åsidosätter standardinställningarna här.
properties.defaultTopic	Topic	Objekt som beskriver standardämnesinformationen för tillgången.
properties.discoveryId	string	Identifierare som används för att identifiera ändringar i tillgången.
properties.documentationUri	string	Referens till dokumentationen.
properties.events	DiscoveredEvent[]	Matris med händelser som är en del av tillgången. Varje händelse kan ha konfiguration per händelse.
properties.hardwareRevision	string	Revisionsnummer för maskinvaran.
properties.manufacturer	string	Namn på tillgångstillverkare.
properties.manufacturerUri	string	Tillgångstillverkarens URI.
properties.model	string	Namn på tillgångsmodell.
properties.productCode	string	Tillgångsproduktkod.
properties.provisioningState	ProvisioningState	Etableringstillstånd för resursen.
properties.serialNumber	string	Tillgångsserienummer.
properties.softwareRevision	string	Revisionsnummer för programvaran.
properties.version	integer (int64)	Ett heltal som ökas varje gång resursen ändras.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Resurstaggar.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

DiscoveredAssetListResult

Objekt

Svaret från en DiscoveredAsset-liståtgärd.

Name	Typ	Description
nextLink	string (uri)	Länken till nästa sida med objekt
value	DiscoveredAsset[]	Objekten DiscoveredAsset på den här sidan

DiscoveredDataPoint

Objekt

Definierar datapunktsegenskaperna.

Name	Typ	Description
dataPointConfiguration	string	Strängifierad JSON som innehåller anslutningsspecifik konfiguration för datapunkten. För OPC UA kan detta omfatta konfiguration som publishingInterval, samplingInterval och queueSize.
dataSource	string	Adressen till datakällan i tillgången (t.ex. URL) så att en klient kan komma åt datakällan på tillgången.
lastUpdatedOn	string (date-time)	UTC-tidsstämpel som anger när datapunkten lades till eller ändrades.
name	string	Namnet på datapunkten.

DiscoveredDataset

Objekt

Definierar egenskaperna för datamängden.

Name	Typ	Description
dataPoints	DiscoveredDataPoint[]	Matris med datapunkter som ingår i datauppsättningen. Varje datapunkt kan ha konfiguration per datapunkt.
datasetConfiguration	string	Strängifierad JSON som innehåller anslutningsspecifika egenskaper som beskriver konfigurationen för den specifika datauppsättningen.
name	string	Namnet på datauppsättningen.
topic	Topic	Objekt som beskriver ämnesinformationen för den specifika datauppsättningen.

DiscoveredEvent

Objekt

Definierar händelseegenskaperna.

Name	Typ	Description
eventConfiguration	string	Strängifierad JSON som innehåller anslutningsspecifik konfiguration för händelsen. För OPC UA kan detta omfatta konfiguration som publishingInterval, samplingInterval och queueSize.
eventNotifier	string	Adressen till anmälaren för händelsen i tillgången (t.ex. URL) så att en klient kan komma åt händelsen på tillgången.
lastUpdatedOn	string (date-time)	UTC-tidsstämpel som anger när händelsen lades till eller ändrades.
name	string	Namnet på händelsen.
topic	Topic	Objekt som beskriver ämnesinformationen för den specifika händelsen.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ExtendedLocation

Objekt

Den utökade platsen.

Name	Typ	Description
name	string	Namnet på den utökade platsen.
type	string	Den utökade platstypen.

ProvisioningState

Uppräkning

Resursens etableringsstatus.

Värde	Description
Accepted	Resursen har godkänts av servern.
Canceled	Resursskapandet avbröts.
Deleting	Resursen tas bort.
Failed	Det gick inte att skapa resurser.
Succeeded	Resursen har skapats.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Topic

Objekt

Objekt som beskriver ämnesinformationen.

Name	Typ	Standardvärde	Description
path	string		Ämnessökvägen för meddelanden som publicerats till en MQTT-asynkron meddelandekö.
retain	TopicRetainType	Never	När det är inställt på "Behåll" har meddelanden som publicerats till en MQTT-asynkron meddelandekö kvarhållningsflaggan inställd. Standard: "Aldrig".

TopicRetainType

Uppräkning

När det är inställt på "Behåll" har meddelanden som publicerats till en MQTT-asynkron meddelandekö kvarhållningsflaggan inställd. Standard: "Aldrig".

Värde	Description
Keep	Behåll meddelandena.
Never	Behåll aldrig meddelanden.