az iot hub digital-twin

  • 참조

참고 항목

이 참조는 Azure CLI(버전 2.37.0 이상)에 대한 azure-iot 확장의 일부입니다. az iot hub digital-twin 명령을 처음 실행할 때 확장이 자동으로 설치됩니다. 확장 프로그램에 대해 자세히 알아보세요.

IoT Hub 디바이스의 디지털 트윈을 조작하고 상호 작용합니다.

명령

Name Description 형식 상태
az iot hub digital-twin invoke-command

디지털 트윈 디바이스의 루트 또는 구성 요소 수준 명령을 호출합니다.

 내선 번호 GA
az iot hub digital-twin show

IoT Hub 디바이스의 디지털 트윈을 표시합니다.

 내선 번호 GA
az iot hub digital-twin update

JSON 패치 사양을 통해 디지털 트윈 디바이스의 읽기-쓰기 속성을 업데이트합니다.

 내선 번호 GA

az iot hub digital-twin invoke-command

디지털 트윈 디바이스의 루트 또는 구성 요소 수준 명령을 호출합니다.

az iot hub digital-twin invoke-command --cn
                                       --device-id
                                       [--component-path]
                                       [--connect-timeout]
                                       [--hub-name]
                                       [--login]
                                       [--payload]
                                       [--resource-group]
                                       [--response-timeout]

예제

일반적으로 인라인 JSON을 사용하여 특정 속성을 포함하는 페이로드를 사용하는 명령을 호출합니다.

az iot hub digital-twin invoke-command --command-name {command_name} -n {iothub_name} -d {device_id} --payload '{"property_name": "property_value"}'

DTDL 모델을 준수하는 "delay"라는 페이로드를 사용하는 루트 수준 명령 "reboot"을 호출합니다. https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/samples/TemperatureController.json.

az iot hub digital-twin invoke-command --command-name reboot -n {iothub_name} -d {device_id} --payload 5

입력을 사용하지 않는 구성 요소 "thermostat1"에서 "getMaxMinReport" 명령을 호출합니다.

az iot hub digital-twin invoke-command --cn getMaxMinReport -n {iothub_name} -d {device_id} --component-path thermostat1

필수 매개 변수

--cn --command-name

디지털 트윈 명령 이름입니다.

--device-id -d

대상 디바이스 ID입니다.

선택적 매개 변수

--component-path

디지털 트윈 구성 요소 경로입니다. 예: thermostat1.

--connect-timeout --cto

IoT Hub가 디바이스에 연결을 시도하는 최대 시간 간격(초)입니다.

--hub-name -n

IoT Hub 이름 또는 호스트 이름입니다. --login이 제공되지 않은 경우 필요합니다.

--login -l

이 명령은 작업을 수행할 권한이 있는 엔터티 연결 문자열 지원합니다. "az login"을 통해 세션 로그인을 방지하는 데 사용합니다. 엔터티 연결 문자열 및 이름이 모두 제공되면 연결 문자열 우선 순위가 지정됩니다. --hub-name이 제공되지 않은 경우 필요합니다.

--payload

명령에 대한 JSON 페이로드 입력입니다. 파일 경로 또는 인라인 JSON을 제공합니다.

기본값: {}
--resource-group -g

리소스 그룹의 이름입니다. 를 사용하여 az configure --defaults group=<name>기본 그룹을 구성할 수 있습니다.

--response-timeout --rto

디지털 트윈 명령이 결과를 기다리는 최대 시간 간격(초)입니다.

전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

구독의 이름 또는 ID입니다. 를 사용하여 az account set -s NAME_OR_ID기본 구독을 구성할 수 있습니다.

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.

az iot hub digital-twin show

IoT Hub 디바이스의 디지털 트윈을 표시합니다.

az iot hub digital-twin show --device-id
                             [--hub-name]
                             [--login]
                             [--resource-group]

예제

대상 디바이스 디지털 트윈을 표시합니다.

az iot hub digital-twin show -n {iothub_name} -d {device_id}

필수 매개 변수

--device-id -d

대상 디바이스 ID입니다.

선택적 매개 변수

--hub-name -n

IoT Hub 이름 또는 호스트 이름입니다. --login이 제공되지 않은 경우 필요합니다.

--login -l

이 명령은 작업을 수행할 권한이 있는 엔터티 연결 문자열 지원합니다. "az login"을 통해 세션 로그인을 방지하는 데 사용합니다. 엔터티 연결 문자열 및 이름이 모두 제공되면 연결 문자열 우선 순위가 지정됩니다. --hub-name이 제공되지 않은 경우 필요합니다.

--resource-group -g

리소스 그룹의 이름입니다. 를 사용하여 az configure --defaults group=<name>기본 그룹을 구성할 수 있습니다.

전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

구독의 이름 또는 ID입니다. 를 사용하여 az account set -s NAME_OR_ID기본 구독을 구성할 수 있습니다.

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.

az iot hub digital-twin update

JSON 패치 사양을 통해 디지털 트윈 디바이스의 읽기-쓰기 속성을 업데이트합니다.

현재 작업은 추가, 바꾸기 및 제거로 제한됩니다.

az iot hub digital-twin update --device-id
                               --json-patch
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

예제

JSON 패치 사양을 통해 디지털 트윈을 업데이트합니다.

az iot hub digital-twin update --hub-name {iothub_name} --device-id {device_id} --json-patch '{"op":"add", "path":"/thermostat1/targetTemperature", "value": 54}'

JSON 패치 사양을 통해 디지털 트윈을 업데이트합니다.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch '[
  {"op":"remove", "path":"/thermostat1/targetTemperature"},
  {"op":"add", "path":"/thermostat2/targetTemperature", "value": 22}
]'

파일에 정의된 JSON 패치 사양을 통해 디지털 트윈 속성을 업데이트합니다.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch ./my/patch/document.json

필수 매개 변수

--device-id -d

대상 디바이스 ID입니다.

--json-patch --patch

JSON 패치에서 설명하는 업데이트 사양입니다. 작업은 추가, 바꾸기 및 제거로 제한됩니다. 파일 경로 또는 인라인 JSON을 제공합니다.

선택적 매개 변수

--etag -e

리소스의 마지막 상태에 해당하는 Etag 또는 엔터티 태그입니다. etag가 제공되지 않으면 값 '*'이 사용됩니다.

--hub-name -n

IoT Hub 이름 또는 호스트 이름입니다. --login이 제공되지 않은 경우 필요합니다.

--login -l

이 명령은 작업을 수행할 권한이 있는 엔터티 연결 문자열 지원합니다. "az login"을 통해 세션 로그인을 방지하는 데 사용합니다. 엔터티 연결 문자열 및 이름이 모두 제공되면 연결 문자열 우선 순위가 지정됩니다. --hub-name이 제공되지 않은 경우 필요합니다.

--resource-group -g

리소스 그룹의 이름입니다. 를 사용하여 az configure --defaults group=<name>기본 그룹을 구성할 수 있습니다.

전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

구독의 이름 또는 ID입니다. 를 사용하여 az account set -s NAME_OR_ID기본 구독을 구성할 수 있습니다.

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.