az iot ops ns asset rest

Förhandsgranskning

Note

Den här referensen är en del av azure-iot-ops-tillägget för Azure CLI (version 2.67.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot ops ns asset rest-kommando . Läs mer om tillägg.

Kommandogruppen "iot ops ns" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hantera namnområdestillgångar som pekar på REST-enhetsslutpunkter.

Kommandon

Name	Description	Typ	Status
az iot ops ns asset rest create	Skapa en REST-namnrymdstillgång i en IoT Operations-instans.	Extension	Preview
az iot ops ns asset rest dataset	Hantera datauppsättningar för REST-namnrymdstillgångar i en IoT Operations-instans.	Extension	Preview
az iot ops ns asset rest dataset add	Lägg till en datauppsättning i en REST-namnrymdstillgång i en IoT Operations-instans.	Extension	Preview
az iot ops ns asset rest dataset list	Visa en lista över datauppsättningar för en REST-namnrymdstillgång i en IoT Operations-instans.	Extension	Preview
az iot ops ns asset rest dataset remove	Ta bort en datauppsättning från en REST-namnrymdstillgång i en IoT Operations-instans.	Extension	Preview
az iot ops ns asset rest dataset show	Visa information om en datauppsättning för en REST-namnrymdstillgång i en IoT Operations-instans.	Extension	Preview
az iot ops ns asset rest dataset update	Uppdatera en datauppsättning för en REST-namnrymdstillgång i en IoT Operations-instans.	Extension	Preview
az iot ops ns asset rest update	Uppdatera en REST-namnrymdstillgång i en IoT Operations-instans.	Extension	Preview

az iot ops ns asset rest create

Förhandsgranskning

Kommandogruppen "iot ops ns" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Skapa en REST-namnrymdstillgång i en IoT Operations-instans.

Enhetens slutpunkt måste vara av typen Microsoft.Http.

az iot ops ns asset rest create --device
                                --endpoint --ep
                                --instance
                                --name
                                --resource-group
                                [--asset-type-ref --type-ref]
                                [--attr --attribute]
                                [--dataset-dest --dsd]
                                [--description]
                                [--disable {false, true}]
                                [--display-name --dn]
                                [--doc-uri --documentation-uri]
                                [--eid --external-asset-id]
                                [--hardware-revision --hw-rev]
                                [--manufacturer]
                                [--manufacturer-uri --mfr-uri]
                                [--model]
                                [--pc --product-code]
                                [--sampling-int --si]
                                [--serial-number --sn]
                                [--software-revision --sw-rev]
                                [--tags]

Exempel

Skapa en grundläggande REST-tillgång

az iot ops ns asset rest create --name myrestasset --instance myInstance -g myInstanceResourceGroup --device myrestdevice --endpoint myRestEndpoint

Skapa en REST-tillgång med konfiguration av datauppsättning

az iot ops ns asset rest create --name myrestasset --instance myInstance -g myInstanceResourceGroup --device myrestdevice --endpoint myRestEndpoint --sampling-int 5000

Skapa en REST-tillgång med datamängdens mål

az iot ops ns asset rest create --name myrestasset --instance myInstance -g myInstanceResourceGroup --device myrestdevice --endpoint myRestEndpoint --dataset-dest topic="factory/rest/data" retain=Never qos=Qos1 ttl=3600

Skapa en REST-tillgång med anpassad konfiguration och BrokerStateStore-mål

az iot ops ns asset rest create --name myrestasset --instance myInstance -g myInstanceResourceGroup --device myrestdevice --endpoint myRestEndpoint --sampling-int 2000 --dataset-dest key="rest-data-cache"

Skapa en REST-tillgång med ytterligare metadata

az iot ops ns asset rest create --name myrestasset --instance myInstance -g myInstanceResourceGroup --device myrestdevice --endpoint myRestEndpoint --description "Temperature sensor API" --display-name "Facility Temperature Monitor" --model "TempSensor-3000" --manufacturer "SensorCorp" --serial-number "TS-12345" --documentation-uri "https://example.com/docs/api"

Skapa en REST-tillgång med anpassade attribut

az iot ops ns asset rest create --name myrestasset --instance myInstance -g myInstanceResourceGroup --device myrestdevice --endpoint myRestEndpoint --attribute location=warehouse --attribute sensor-type=temperature --attribute units=celsius

Obligatoriska parametrar

--device -d

Enhetsnamn.

--endpoint --ep

Enhetens slutpunktsnamn.

--instance -i

Namnet på Azure IoT Operations-instansen.

--name -n

Namnet på tillgången.

--resource-group -g

Resursgruppen för Azure IoT Operations-instansen.

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--asset-type-ref --type-ref

Blankstegsavgränsad lista med tillgångstypsreferenser.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--attr --attribute

Blankstegsavgränsad nyckel=värdepar för anpassade tillgångsattribut.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--dataset-dest --dsd

Key=value pairs som representerar målet för datauppsättningar. Tillåtna argument är: key för BrokerStateStore eller topic, retain, qosoch ttl för MQTT. Tillåtna värden för retain är Never och Keep och tillåtna värden för qos är Qos0 och Qos1.

--description

Beskrivning av tillgången.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--disable

Inaktivera tillgången.

Egenskap	Värde
Parameter group:	Additional Info Arguments
Godkända värden:	false, true

--display-name --dn

Visningsnamn för tillgången.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--doc-uri --documentation-uri

Dokumentations-URI för tillgången.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--eid --external-asset-id

Externt tillgångs-ID.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--hardware-revision --hw-rev

Information om maskinvarurevision.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--manufacturer

Tillverkarens namn.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--manufacturer-uri --mfr-uri

Tillverkarens URI.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--model

Modellnamn eller -nummer.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--pc --product-code

Produktkod.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--sampling-int --si

Samplingsintervall för datamängder i millisekunder. Minimum: -1.

--serial-number --sn

Serienummer.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--software-revision --sw-rev

Information om programvarurevision.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

az iot ops ns asset rest update

Förhandsgranskning

Kommandogruppen "iot ops ns" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Uppdatera en REST-namnrymdstillgång i en IoT Operations-instans.

Enhetens slutpunkt måste vara av typen Microsoft.Http.

az iot ops ns asset rest update --instance
                                --name
                                --resource-group
                                [--asset-type-ref --type-ref]
                                [--attr --attribute]
                                [--dataset-dest --dsd]
                                [--description]
                                [--disable {false, true}]
                                [--display-name --dn]
                                [--doc-uri --documentation-uri]
                                [--eid --external-asset-id]
                                [--hardware-revision --hw-rev]
                                [--manufacturer]
                                [--manufacturer-uri --mfr-uri]
                                [--model]
                                [--pc --product-code]
                                [--sampling-int --si]
                                [--serial-number --sn]
                                [--software-revision --sw-rev]
                                [--tags]

Exempel

Uppdatera en REST-tillgångs grundläggande egenskaper

az iot ops ns asset rest update --name myrestasset --instance myInstance -g myInstanceResourceGroup --description "Updated temperature sensor API" --display-name "Main Warehouse Temperature"

Uppdatera en REST-tillgångs datauppsättningsmål till MQTT

az iot ops ns asset rest update --name myrestasset --instance myInstance -g myInstanceResourceGroup --dataset-dest topic="factory/rest/updated/data" retain=Keep qos=Qos1 ttl=7200

Uppdatera en REST-tillgångs datauppsättningsmål till BrokerStateStore

az iot ops ns asset rest update --name myrestasset --instance myInstance -g myInstanceResourceGroup --dataset-dest key="updated-rest-cache"

Uppdatera en REST-tillgångs metadata

az iot ops ns asset rest update --name myrestasset --instance myInstance -g myInstanceResourceGroup --model "TempSensor-4000" --manufacturer "SensorCorp" --serial-number "TS-67890" --documentation-uri "https://example.com/docs/api/v2"

Uppdatera en REST-tillgångs anpassade attribut

az iot ops ns asset rest update --name myrestasset --instance myInstance -g myInstanceResourceGroup --attribute location=main-warehouse sensor-type=temperature units=fahrenheit accuracy=high

Inaktivera en REST-tillgång och uppdatera dess referensinformation

az iot ops ns asset rest update --name myrestasset --instance myInstance -g myInstanceResourceGroup --disable --external-asset-id "TEMP-MAIN-01" --hardware-revision "v2.1"

Obligatoriska parametrar

--instance -i

Namnet på Azure IoT Operations-instansen.

--name -n

Namnet på tillgången.

--resource-group -g

Resursgruppen för Azure IoT Operations-instansen.

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--asset-type-ref --type-ref

Blankstegsavgränsad lista med tillgångstypsreferenser.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--attr --attribute

Blankstegsavgränsad nyckel=värdepar för anpassade tillgångsattribut.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--dataset-dest --dsd

--description

Beskrivning av tillgången.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--disable

Inaktivera tillgången.

Egenskap	Värde
Parameter group:	Additional Info Arguments
Godkända värden:	false, true

--display-name --dn

Visningsnamn för tillgången.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--doc-uri --documentation-uri

Dokumentations-URI för tillgången.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--eid --external-asset-id

Externt tillgångs-ID.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--hardware-revision --hw-rev

Information om maskinvarurevision.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--manufacturer

Tillverkarens namn.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--manufacturer-uri --mfr-uri

Tillverkarens URI.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--model

Modellnamn eller -nummer.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--pc --product-code

Produktkod.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--sampling-int --si

Samplingsintervall för datamängder i millisekunder. Minimum: -1.

--serial-number --sn

Serienummer.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--software-revision --sw-rev

Information om programvarurevision.

Egenskap	Värde
Parameter group:	Additional Info Arguments

--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

Feedback

Var den här sidan till hjälp?

Dela via

az iot ops ns asset rest

Kommandon

az iot ops ns asset rest create

Exempel

Obligatoriska parametrar

Valfria parametrar

az iot ops ns asset rest update

Exempel

Obligatoriska parametrar

Valfria parametrar

Feedback