다음을 통해 공유

az iot hub message-route

  • 미리 보기

Note

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

이 명령 그룹은 미리 보기 상태이며 개발 중입니다. 참조 및 지원 수준: https://aka.ms/CLI_refstatus

IoT 허브의 경로를 관리합니다.

명령

Name Description 형식 상태
az iot hub message-route create

IoT Hub에 대한 경로를 추가합니다.

 Extension Preview
az iot hub message-route delete

IoT Hub에서 모든 경로 또는 언급된 경로를 삭제합니다.

 Extension Preview
az iot hub message-route fallback

IoT Hub의 대체 경로를 관리합니다.

 Extension Preview
az iot hub message-route fallback set

IoT Hub에서 대체 경로를 사용하거나 사용하지 않도록 설정합니다.

 Extension Preview
az iot hub message-route fallback show

IoT Hub의 대체 경로를 표시합니다.

 Extension Preview
az iot hub message-route list

IoT Hub의 모든 경로를 가져옵니다.

 Extension Preview
az iot hub message-route show

IoT Hub에서 경로에 대한 정보를 가져옵니다.

 Extension Preview
az iot hub message-route test

IoT Hub에서 모든 경로 또는 언급된 경로를 테스트합니다.

 Extension Preview
az iot hub message-route update

IoT Hub에 대한 경로를 업데이트합니다.

 Extension Preview

az iot hub message-route create

미리 보기

명령 그룹 'iot hub message-route'는 미리 보기로 개발 중입니다. 참조 및 지원 수준: https://aka.ms/CLI_refstatus

IoT Hub에 대한 경로를 추가합니다.

az iot hub message-route create --en --endpoint --endpoint-name
                                --hub-name
                                --rn --route --route-name
                                --source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}
                                [--condition]
                                [--enabled {false, true}]
                                [--resource-group]

예제

지정된 엔드포인트 및 원본 유형 "DeviceMessages"를 사용하여 IoT Hub에 대한 경로를 만듭니다.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

기본 제공 엔드포인트 및 원본 형식 "DeviceMessages"를 사용하여 IoT Hub에 대한 경로를 만듭니다.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name events --source DeviceMessages

지정된 엔드포인트, 원본 유형 "DigitalTwinChangeEvents" 및 사용자 지정 조건을 사용하여 IoT Hub에 대해 비활성화된 경로를 만듭니다.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DigitalTwinChangeEvents --condition {condition} --enabled false

필수 매개 변수

--en --endpoint --endpoint-name

라우팅 엔드포인트의 이름입니다. 기본 제공 엔드포인트의 경우 엔드포인트 이름 'events'를 사용합니다.

--hub-name -n

IoT Hub 이름입니다.

--rn --route --route-name

경로의 이름입니다.

--source-type --type -t

경로의 원본입니다.

속성 값
허용되는 값: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

선택적 매개 변수

다음 매개 변수는 선택 사항이지만 컨텍스트에 따라 명령이 성공적으로 실행되려면 하나 이상의 매개 변수가 필요할 수 있습니다.

--condition -c

라우팅 규칙을 적용하기 위해 평가되는 조건입니다.

속성 값
Default value: true
--enabled -e

IoT Hub에 대한 경로를 사용하도록 설정할지 여부를 나타내는 부울입니다.

속성 값
Default value: True
허용되는 값: false, true
--resource-group -g

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

전역 매개 변수
--debug

로깅 수위를 높여 모든 디버그 로그를 표시합니다.

속성 값
Default value: False
--help -h

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

--only-show-errors

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

속성 값
Default value: False
--output -o

출력 형식

속성 값
Default value: json
허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.

속성 값
Default value: False

az iot hub message-route delete

미리 보기

명령 그룹 'iot hub message-route'는 미리 보기로 개발 중입니다. 참조 및 지원 수준: https://aka.ms/CLI_refstatus

IoT Hub에서 모든 경로 또는 언급된 경로를 삭제합니다.

az iot hub message-route delete [--hub-name]
                                [--ids]
                                [--resource-group]
                                [--rn --route --route-name]
                                [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--subscription]
                                [--yes {false, true}]

예제

IoT Hub에서 경로를 삭제합니다.

az iot hub message-route delete -n {iothub_name} --route-name {route_name}

IoT Hub에서 원본 형식 "DeviceMessages"의 모든 경로를 삭제합니다.

az iot hub message-route delete -n {iothub_name} --source DeviceMessages

IoT Hub에서 모든 경로를 삭제합니다.

az iot hub message-route delete -n {iothub_name}

선택적 매개 변수

다음 매개 변수는 선택 사항이지만 컨텍스트에 따라 명령이 성공적으로 실행되려면 하나 이상의 매개 변수가 필요할 수 있습니다.

--hub-name -n

IoT Hub 이름입니다.

속성 값
매개 변수 그룹: Resource Id Arguments
--ids

하나 이상의 리소스 ID(공백으로 구분). '리소스 ID' 인수의 모든 정보를 포함하는 전체 리소스 ID여야 합니다. --ids 또는 다른 '리소스 ID' 인수를 제공해야 합니다.

속성 값
매개 변수 그룹: Resource Id Arguments
--resource-group -g

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

속성 값
매개 변수 그룹: Resource Id Arguments
--rn --route --route-name

경로의 이름입니다.

--source-type --type -t

경로의 원본입니다.

속성 값
허용되는 값: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

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

속성 값
매개 변수 그룹: Resource Id Arguments
--yes -y

사용자 프롬프트를 건너뜁니다. 작업 수락을 나타냅니다. 자동화 시나리오에 주로 사용됩니다. 기본값: false입니다.

속성 값
허용되는 값: false, true
전역 매개 변수
--debug

로깅 수위를 높여 모든 디버그 로그를 표시합니다.

속성 값
Default value: False
--help -h

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

--only-show-errors

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

속성 값
Default value: False
--output -o

출력 형식

속성 값
Default value: json
허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.

속성 값
Default value: False

az iot hub message-route list

미리 보기

명령 그룹 'iot hub message-route'는 미리 보기로 개발 중입니다. 참조 및 지원 수준: https://aka.ms/CLI_refstatus

IoT Hub의 모든 경로를 가져옵니다.

az iot hub message-route list [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                              [--subscription]

예제

IoT Hub에서 모든 경로를 가져옵니다.

az iot hub message-route list -n {iothub_name}

IoT Hub에서 원본 형식 "DeviceMessages"의 모든 경로를 가져옵니다.

az iot hub message-route list -n {iothub_name} --source DeviceMessages

선택적 매개 변수

다음 매개 변수는 선택 사항이지만 컨텍스트에 따라 명령이 성공적으로 실행되려면 하나 이상의 매개 변수가 필요할 수 있습니다.

--hub-name -n

IoT Hub 이름입니다.

속성 값
매개 변수 그룹: Resource Id Arguments
--ids

하나 이상의 리소스 ID(공백으로 구분). '리소스 ID' 인수의 모든 정보를 포함하는 전체 리소스 ID여야 합니다. --ids 또는 다른 '리소스 ID' 인수를 제공해야 합니다.

속성 값
매개 변수 그룹: Resource Id Arguments
--resource-group -g

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

속성 값
매개 변수 그룹: Resource Id Arguments
--source-type --type -t

경로의 원본입니다.

속성 값
허용되는 값: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

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

속성 값
매개 변수 그룹: Resource Id Arguments
전역 매개 변수
--debug

로깅 수위를 높여 모든 디버그 로그를 표시합니다.

속성 값
Default value: False
--help -h

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

--only-show-errors

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

속성 값
Default value: False
--output -o

출력 형식

속성 값
Default value: json
허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.

속성 값
Default value: False

az iot hub message-route show

미리 보기

명령 그룹 'iot hub message-route'는 미리 보기로 개발 중입니다. 참조 및 지원 수준: https://aka.ms/CLI_refstatus

IoT Hub에서 경로에 대한 정보를 가져옵니다.

az iot hub message-route show --rn --route --route-name
                              [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--subscription]

예제

IoT Hub에서 경로 정보를 가져옵니다.

az iot hub message-route show -n {iothub_name} --route-name {route_name}

필수 매개 변수

--rn --route --route-name

경로의 이름입니다.

선택적 매개 변수

다음 매개 변수는 선택 사항이지만 컨텍스트에 따라 명령이 성공적으로 실행되려면 하나 이상의 매개 변수가 필요할 수 있습니다.

--hub-name -n

IoT Hub 이름입니다.

속성 값
매개 변수 그룹: Resource Id Arguments
--ids

하나 이상의 리소스 ID(공백으로 구분). '리소스 ID' 인수의 모든 정보를 포함하는 전체 리소스 ID여야 합니다. --ids 또는 다른 '리소스 ID' 인수를 제공해야 합니다.

속성 값
매개 변수 그룹: Resource Id Arguments
--resource-group -g

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

속성 값
매개 변수 그룹: Resource Id Arguments
--subscription

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

속성 값
매개 변수 그룹: Resource Id Arguments
전역 매개 변수
--debug

로깅 수위를 높여 모든 디버그 로그를 표시합니다.

속성 값
Default value: False
--help -h

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

--only-show-errors

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

속성 값
Default value: False
--output -o

출력 형식

속성 값
Default value: json
허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.

속성 값
Default value: False

az iot hub message-route test

미리 보기

명령 그룹 'iot hub message-route'는 미리 보기로 개발 중입니다. 참조 및 지원 수준: https://aka.ms/CLI_refstatus

IoT Hub에서 모든 경로 또는 언급된 경로를 테스트합니다.

경로를 테스트하는 샘플 메시지를 제공할 수 있습니다.

az iot hub message-route test [--ap --app-properties]
                              [--body]
                              [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--rn --route --route-name]
                              [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                              [--sp --system-properties]
                              [--subscription]

예제

IoT Hub에서 경로를 테스트합니다.

az iot hub message-route test -n {iothub_name} --route-name {route_name}

IoT Hub에서 원본 형식 "DeviceMessages"의 모든 경로를 테스트합니다.

az iot hub message-route test -n {iothub_name} --source DeviceMessages

본문, 앱 속성 및 시스템 속성을 포함하여 사용자 지정 메시지를 사용하여 IoT Hub의 모든 경로를 테스트합니다.

az iot hub message-route test -n {iothub_name} -b {body} --ap {app_properties} --sp {system_properties}

선택적 매개 변수

다음 매개 변수는 선택 사항이지만 컨텍스트에 따라 명령이 성공적으로 실행되려면 하나 이상의 매개 변수가 필요할 수 있습니다.

--ap --app-properties

경로 메시지의 앱 속성입니다.

--body -b

경로 메시지의 본문입니다.

--hub-name -n

IoT Hub 이름입니다.

속성 값
매개 변수 그룹: Resource Id Arguments
--ids

하나 이상의 리소스 ID(공백으로 구분). '리소스 ID' 인수의 모든 정보를 포함하는 전체 리소스 ID여야 합니다. --ids 또는 다른 '리소스 ID' 인수를 제공해야 합니다.

속성 값
매개 변수 그룹: Resource Id Arguments
--resource-group -g

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

속성 값
매개 변수 그룹: Resource Id Arguments
--rn --route --route-name

경로의 이름입니다.

--source-type --type -t

경로의 원본입니다.

속성 값
허용되는 값: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--sp --system-properties

경로 메시지의 시스템 속성입니다.

--subscription

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

속성 값
매개 변수 그룹: Resource Id Arguments
전역 매개 변수
--debug

로깅 수위를 높여 모든 디버그 로그를 표시합니다.

속성 값
Default value: False
--help -h

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

--only-show-errors

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

속성 값
Default value: False
--output -o

출력 형식

속성 값
Default value: json
허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.

속성 값
Default value: False

az iot hub message-route update

미리 보기

명령 그룹 'iot hub message-route'는 미리 보기로 개발 중입니다. 참조 및 지원 수준: https://aka.ms/CLI_refstatus

IoT Hub에 대한 경로를 업데이트합니다.

경로에서 원본, 엔드포인트, 조건 또는 사용 상태를 변경할 수 있습니다.

az iot hub message-route update --rn --route --route-name
                                [--condition]
                                [--en --endpoint --endpoint-name]
                                [--enabled {false, true}]
                                [--hub-name]
                                [--ids]
                                [--resource-group]
                                [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--subscription]

예제

지정된 엔드포인트 및 원본 유형 "DeviceMessages"로 경로를 업데이트합니다.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

경로를 사용하지 않도록 설정합니다.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --enabled false

경로의 조건을 변경합니다.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --condition {condition}

필수 매개 변수

--rn --route --route-name

경로의 이름입니다.

선택적 매개 변수

다음 매개 변수는 선택 사항이지만 컨텍스트에 따라 명령이 성공적으로 실행되려면 하나 이상의 매개 변수가 필요할 수 있습니다.

--condition -c

라우팅 규칙을 적용하기 위해 평가되는 조건입니다.

--en --endpoint --endpoint-name

라우팅 엔드포인트의 이름입니다. 기본 제공 엔드포인트의 경우 엔드포인트 이름 'events'를 사용합니다.

--enabled -e

IoT Hub에 대한 경로를 사용하도록 설정할지 여부를 나타내는 부울입니다.

속성 값
허용되는 값: false, true
--hub-name -n

IoT Hub 이름입니다.

속성 값
매개 변수 그룹: Resource Id Arguments
--ids

하나 이상의 리소스 ID(공백으로 구분). '리소스 ID' 인수의 모든 정보를 포함하는 전체 리소스 ID여야 합니다. --ids 또는 다른 '리소스 ID' 인수를 제공해야 합니다.

속성 값
매개 변수 그룹: Resource Id Arguments
--resource-group -g

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

속성 값
매개 변수 그룹: Resource Id Arguments
--source-type --type -t

경로의 원본입니다.

속성 값
허용되는 값: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

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

속성 값
매개 변수 그룹: Resource Id Arguments
전역 매개 변수
--debug

로깅 수위를 높여 모든 디버그 로그를 표시합니다.

속성 값
Default value: False
--help -h

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

--only-show-errors

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

속성 값
Default value: False
--output -o

출력 형식

속성 값
Default value: json
허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.

속성 값
Default value: False