az dt twin

  • Referentie

Notitie

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.37.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az dt twin-opdracht uitvoert. Meer informatie over extensies.

Beheer en configureer de digitale dubbels van een Digital Twins-exemplaar.

Opdracht

Name Description Type Status
az dt twin component

De digitale dubbelonderdelen van een Digital Twins-exemplaar weergeven en bijwerken.

 Toestel GA
az dt twin component show

Details van een digital twin-onderdeel weergeven.

 Toestel GA
az dt twin component update

Werk een digital twin-onderdeel bij via de JSON-patchspecificatie.

 Toestel GA
az dt twin create

Maak een digitale dubbel op een exemplaar.

 Toestel GA
az dt twin delete

Een digitale dubbel verwijderen. Alle relaties die naar deze dubbel verwijzen, moeten al worden verwijderd.

 Toestel GA
az dt twin delete-all

Hiermee verwijdert u alle digitale dubbels binnen een Digital Twins-exemplaar, inclusief alle relaties voor die tweelingen.

 Toestel GA
az dt twin query

Voer een query uit op de digitale dubbels van een exemplaar. Hiermee staat u doorkruisingsrelaties toe en filtert u op eigenschapswaarden.

 Toestel GA
az dt twin relationship

Beheer en configureer de digitale dubbelrelaties van een Digital Twins-exemplaar.

 Toestel GA
az dt twin relationship create

Maak een relatie tussen de digitale dubbels van de bron en het doel.

 Toestel GA
az dt twin relationship delete

Een digitale dubbelrelatie op een Digital Twins-exemplaar verwijderen.

 Toestel GA
az dt twin relationship delete-all

Hiermee verwijdert u alle digitale dubbelrelaties binnen een Digital Twins-exemplaar, inclusief binnenkomende relaties.

 Toestel GA
az dt twin relationship list

De relaties van een digitale dubbel weergeven.

 Toestel GA
az dt twin relationship show

Details van een digitale dubbelrelatie weergeven.

 Toestel GA
az dt twin relationship update

Hiermee worden de eigenschappen van een relatie tussen twee digitale dubbels bijgewerkt via de JSON-patchspecificatie.

 Toestel GA
az dt twin show

De details van een digitale dubbel weergeven.

 Toestel GA
az dt twin telemetry

Test en valideer de gebeurtenisroutes en eindpunten van een Digital Twins-exemplaar.

 Toestel GA
az dt twin telemetry send

Verzendt telemetrie namens een digitale dubbel. Als het onderdeelpad wordt opgegeven, is de verzonden telemetrie namens het onderdeel.

 Toestel GA
az dt twin update

Werk een digitale exemplaardubbel bij via de JSON-patchspecificatie.

 Toestel GA

az dt twin create

Maak een digitale dubbel op een exemplaar.

--properties kunnen inline JSON of bestandspad zijn. Opmerking: --eigenschappen zijn vereist voor tweelingen die onderdelen bevatten.

az dt twin create --dt-name
                  --dtmi
                  --twin-id
                  [--if-none-match]
                  [--properties]
                  [--resource-group]

Voorbeelden

Maak een digitale dubbel op basis van een bestaand (vooraf gemaakt) model.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id}

Maak een digitale dubbel op basis van een bestaand (vooraf gemaakt) model met de tag if-none-match.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id} --if-none-match

Maak een digitale dubbel op basis van een bestaand (vooraf gemaakt) model. Instantieer met eigenschapswaarden.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:DeviceInformation;1" --twin-id {twin_id} --properties '{"manufacturer": "Microsoft"}'

Maak een digitale dubbel met een onderdeel op basis van bestaande (vooraf gemaakte) modellen. Instantieer een onderdeel met minimale eigenschappen.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
    "Thermostat": {
        "$metadata": {},
    }
}'

Maak een digitale dubbel met een onderdeel op basis van bestaande (vooraf gemaakte) modellen. Instantieer met eigenschapswaarden.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
    "Temperature": 10.2,
    "Thermostat": {
        "$metadata": {},
        "setPointTemp": 23.12
    }
}'

Vereiste parameters

--dt-name --dtn -n

Naam of hostnaam van het Digital Twins-exemplaar. Als er een exemplaarnaam wordt opgegeven, wordt het gebruikersabonnement eerst opgevraagd voor het doelexemplaren om de hostnaam op te halen. Als er een hostnaam wordt opgegeven, wordt de abonnementsquery overgeslagen en wordt de opgegeven waarde gebruikt voor volgende interactie.

--dtmi --model-id -m

Digital Twins-model-id. Voorbeeld: dtmi:com:example:Room;2.

--twin-id -t

De digitale dubbel-id.

Optionele parameters

--if-none-match

Geeft aan dat de maakbewerking moet mislukken als er een bestaande dubbel met dezelfde id bestaat.

standaardwaarde: False
--properties -p

Initiële eigenschapswaarden voor het instantiëren van een digitale dubbel of gerelateerde onderdelen. Geef bestandspad of inline-JSON op. Eigenschappen zijn vereist voor dubbels die onderdelen bevatten. U moet minimaal een leeg $metadata-object opgeven voor elk onderdeel.

--resource-group -g

Resourcegroep voor Digital Twins-exemplaren. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az dt twin delete

Een digitale dubbel verwijderen. Alle relaties die naar deze dubbel verwijzen, moeten al worden verwijderd.

az dt twin delete --dt-name
                  --twin-id
                  [--etag]
                  [--resource-group]

Voorbeelden

Verwijder een digitale dubbel op id.

az dt twin delete -n {instance_or_hostname} --twin-id {twin_id}

Verwijder een digitale dubbel met id met behulp van de etag.

az dt twin delete -n {instance_or_hostname} --twin-id {twin_id} --etag {etag}

Vereiste parameters

--dt-name --dtn -n

Naam of hostnaam van het Digital Twins-exemplaar. Als er een exemplaarnaam wordt opgegeven, wordt het gebruikersabonnement eerst opgevraagd voor het doelexemplaren om de hostnaam op te halen. Als er een hostnaam wordt opgegeven, wordt de abonnementsquery overgeslagen en wordt de opgegeven waarde gebruikt voor volgende interactie.

--twin-id -t

De digitale dubbel-id.

Optionele parameters

--etag -e

Waarde van entiteitstag. De opdracht slaagt als de etag overeenkomt met de huidige etag voor de resource.

--resource-group -g

Resourcegroep voor Digital Twins-exemplaren. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az dt twin delete-all

Hiermee verwijdert u alle digitale dubbels binnen een Digital Twins-exemplaar, inclusief alle relaties voor die tweelingen.

az dt twin delete-all --dt-name
                      [--resource-group]
                      [--yes]

Voorbeelden

Verwijder alle digitale dubbels. Alle relaties die naar de tweelingen verwijzen, worden ook verwijderd.

az dt twin delete-all -n {instance_or_hostname}

Vereiste parameters

--dt-name --dtn -n

Naam of hostnaam van het Digital Twins-exemplaar. Als er een exemplaarnaam wordt opgegeven, wordt het gebruikersabonnement eerst opgevraagd voor het doelexemplaren om de hostnaam op te halen. Als er een hostnaam wordt opgegeven, wordt de abonnementsquery overgeslagen en wordt de opgegeven waarde gebruikt voor volgende interactie.

Optionele parameters

--resource-group -g

Resourcegroep voor Digital Twins-exemplaren. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--yes -y

Niet vragen om bevestiging.

standaardwaarde: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az dt twin query

Voer een query uit op de digitale dubbels van een exemplaar. Hiermee staat u doorkruisingsrelaties toe en filtert u op eigenschapswaarden.

In veel dubbelquery's wordt het $ teken gebruikt om te verwijzen naar de $dtId eigenschap van een dubbel. In bash-achtige shells of PowerShell heeft het $ teken functionele betekenis en moet het worden ontsnapt als onderdeel van de query-invoer. Raadpleeg het document https://docs.microsoft.com/en-us/azure/digital-twins/concepts-cli met concepten van Digital Twins CLI voor meer informatie.

az dt twin query --dt-name
                 --query-command
                 [--cost {false, true}]
                 [--resource-group]

Voorbeelden

Voer een query uit op alle digitale dubbels in het doelexemplaren en project alle kenmerken. Ook kosten weergeven in query-eenheden.

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins" --show-cost

Voer een query uit op model en project alle kenmerken.

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins T where IS_OF_MODEL(T, 'dtmi:com:example:Room;2')"

Query die gebruikmaakt van '$dtId' met bash-compatibele syntaxis

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.\$dtId = 'room0'"

Query die gebruikmaakt van '$dtId' met de syntaxis die compatibel is met PowerShell

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.`$dtId = 'room0'"

Vereiste parameters

--dt-name --dtn -n

Naam of hostnaam van het Digital Twins-exemplaar. Als er een exemplaarnaam wordt opgegeven, wordt het gebruikersabonnement eerst opgevraagd voor het doelexemplaren om de hostnaam op te halen. Als er een hostnaam wordt opgegeven, wordt de abonnementsquery overgeslagen en wordt de opgegeven waarde gebruikt voor volgende interactie.

--query-command -q

Gebruikersquery die moet worden uitgevoerd.

Optionele parameters

--cost --show-cost

Berekent en toont de querykosten.

geaccepteerde waarden: false, true
standaardwaarde: False
--resource-group -g

Resourcegroep voor Digital Twins-exemplaren. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az dt twin show

De details van een digitale dubbel weergeven.

az dt twin show --dt-name
                --twin-id
                [--resource-group]

Voorbeelden

De details van een digitale dubbel weergeven.

az dt twin show -n {instance_or_hostname} --twin-id {twin_id}

Vereiste parameters

--dt-name --dtn -n

Naam of hostnaam van het Digital Twins-exemplaar. Als er een exemplaarnaam wordt opgegeven, wordt het gebruikersabonnement eerst opgevraagd voor het doelexemplaren om de hostnaam op te halen. Als er een hostnaam wordt opgegeven, wordt de abonnementsquery overgeslagen en wordt de opgegeven waarde gebruikt voor volgende interactie.

--twin-id -t

De digitale dubbel-id.

Optionele parameters

--resource-group -g

Resourcegroep voor Digital Twins-exemplaren. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az dt twin update

Werk een digitale exemplaardubbel bij via de JSON-patchspecificatie.

Updates voor eigenschapswaarden en $model elementen kunnen plaatsvinden in dezelfde aanvraag. Bewerkingen zijn beperkt tot toevoegen, vervangen en verwijderen.

az dt twin update --dt-name
                  --json-patch
                  --twin-id
                  [--etag]
                  [--resource-group]

Voorbeelden

Werk een digitale dubbel bij via de JSON-patchspecificatie.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}'

Werk een digitale dubbel bij via de JSON-patchspecificatie en met behulp van etag.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --etag {etag} --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}'

Werk een digitale dubbel bij via de JSON-patchspecificatie.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch '[
  {"op":"replace", "path":"/Temperature", "value": 20.5},
  {"op":"add", "path":"/Areas", "value": ["ControlSystem"]}
]'

Werk een digitale dubbel bij via de JSON-patchspecificatie die is gedefinieerd in een bestand.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch ./my/patch/document.json

Vereiste parameters

--dt-name --dtn -n

Naam of hostnaam van het Digital Twins-exemplaar. Als er een exemplaarnaam wordt opgegeven, wordt het gebruikersabonnement eerst opgevraagd voor het doelexemplaren om de hostnaam op te halen. Als er een hostnaam wordt opgegeven, wordt de abonnementsquery overgeslagen en wordt de opgegeven waarde gebruikt voor volgende interactie.

--json-patch --patch

Een updatespecificatie die wordt beschreven door JSON-patch. Updates voor eigenschapswaarden en $model elementen kunnen plaatsvinden in dezelfde aanvraag. Bewerkingen zijn beperkt tot toevoegen, vervangen en verwijderen. Geef bestandspad of inline-JSON op.

--twin-id -t

De digitale dubbel-id.

Optionele parameters

--etag -e

Waarde van entiteitstag. De opdracht slaagt als de etag overeenkomt met de huidige etag voor de resource.

--resource-group -g

Resourcegroep voor Digital Twins-exemplaren. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.