다음을 통해 공유

az iot hub job

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). az iot hub job 명령을 처음 실행할 때 확장이 자동으로 설치됩니다. Learn more about extensions.

IoT Hub 작업(v2)을 관리합니다.

명령

Name Description 형식 상태
az iot hub job cancel

IoT Hub 작업을 취소합니다.

 Extension GA
az iot hub job create

실행을 위해 IoT Hub 작업을 만들고 예약합니다.

 Extension GA
az iot hub job list

IoT Hub의 기록 작업을 나열합니다.

 Extension GA
az iot hub job show

기존 IoT Hub 작업의 세부 정보를 표시합니다.

 Extension GA

az iot hub job cancel

IoT Hub 작업을 취소합니다.

az iot hub job cancel --job-id
                      [--auth-type {key, login}]
                      [--hub-name]
                      [--login]
                      [--resource-group]

예제

IoT Hub 작업을 취소합니다.

az iot hub job cancel --hub-name {iothub_name} --job-id {job_id}

필수 매개 변수

--job-id

IoT Hub 작업 ID입니다.

선택적 매개 변수

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

--auth-type

작업에서 정책 키를 자동으로 파생할지 아니면 현재 Azure AD 세션을 사용해야 하는지 여부를 나타냅니다. 인증 유형이 로그인되고 리소스 호스트 이름이 제공되면 필요한 경우가 아니면 리소스 조회를 건너뜁습니다. az configure --defaults iothub-data-auth-type={auth-type-value}사용하여 기본값을 구성할 수 있습니다.

속성 값
Parameter group: Access Control Arguments
Default value: key
허용되는 값: key, login
--hub-name -n

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

속성 값
Parameter group: IoT Hub Identifier Arguments
--login -l

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

속성 값
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

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

전역 매개 변수
--debug

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

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

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

--only-show-errors

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

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

Output format.

속성 값
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 job create

실행을 위해 IoT Hub 작업을 만들고 예약합니다.

트윈 업데이트 작업을 예약할 때 트윈 패치는 필수 인수입니다. 디바이스 메서드 작업을 예약할 때 메서드 이름과 페이로드는 필수 인수입니다. 참고: 과거 사용자 지정 시작 시간을 사용하면 작업이 실패할 수 있습니다.

az iot hub job create --job-id
                      --job-type --jt {scheduleDeviceMethod, scheduleUpdateTwin}
                      [--auth-type {key, login}]
                      [--duration --poll-duration]
                      [--hub-name]
                      [--interval --poll-interval]
                      [--login]
                      [--mct --method-connect-timeout]
                      [--method-name --mn]
                      [--method-payload --mp]
                      [--method-response-timeout --mrt]
                      [--patch --twin-patch]
                      [--query-condition]
                      [--resource-group]
                      [--start --start-time]
                      [--ttl]
                      [--wait {false, true}]

예제

모든 디바이스의 쌍 태그를 업데이트하는 작업을 만들고 예약합니다.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}'

작업을 예약하고 "완료됨", "실패" 또는 "취소됨" 결과를 차단합니다. 폴링 간격(초)을 지정합니다.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}' --wait --poll-interval 30

나중에 임의로 실행되도록 예약된 디바이스 하위 집합에서 원하는 트윈 속성을 업데이트하는 작업을 만듭니다.

az iot hub job create --job-id {job_name} --job-type scheduleUpdateTwin -n {iothub_name} --twin-patch '{"properties":{"desired": {"temperatureF": 65}}}' --start-time "2050-01-08T12:19:56.868Z" --query-condition "deviceId IN ['MyDevice1', 'MyDevice2', 'MyDevice3']"

쿼리 조건을 충족하는 디바이스 집합에 대한 디바이스 메서드를 호출하는 작업을 만들고 예약합니다.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -n {iothub_name} --method-name setSyncIntervalSec --method-payload 30 --query-condition "properties.reported.settings.syncIntervalSec != 30"

모든 디바이스에 대해 디바이스 메서드를 호출하는 작업을 만들고 예약합니다.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -q "*" -n {iothub_name} --method-name setSyncIntervalSec --method-payload '{"version":"1.0"}'

필수 매개 변수

--job-id

IoT Hub 작업 ID입니다.

--job-type --jt

예약된 작업의 형식입니다.

속성 값
허용되는 값: scheduleDeviceMethod, scheduleUpdateTwin

선택적 매개 변수

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

--auth-type

작업에서 정책 키를 자동으로 파생할지 아니면 현재 Azure AD 세션을 사용해야 하는지 여부를 나타냅니다. 인증 유형이 로그인되고 리소스 호스트 이름이 제공되면 필요한 경우가 아니면 리소스 조회를 건너뜁습니다. az configure --defaults iothub-data-auth-type={auth-type-value}사용하여 기본값을 구성할 수 있습니다.

속성 값
Parameter group: Access Control Arguments
Default value: key
허용되는 값: key, login
--duration --poll-duration

--wait 플래그가 전달되면 작업 상태를 확인하는 총 기간(초)입니다.

속성 값
Default value: 600
--hub-name -n

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

속성 값
Parameter group: IoT Hub Identifier Arguments
--interval --poll-interval

--wait 플래그가 전달되면 작업 상태를 확인하는 간격(초)입니다.

속성 값
Default value: 10
--login -l

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

속성 값
Parameter group: IoT Hub Identifier Arguments
--mct --method-connect-timeout

디바이스 연결에서 대기할 최대 시간(초)입니다.

속성 값
Default value: 30
--method-name --mn

호출에 대한 대상 메서드입니다.

--method-payload --mp

메서드에 전달할 Json 페이로드입니다. 파일 경로 또는 원시 json이어야 합니다.

--method-response-timeout --mrt

디바이스 메서드 결과를 기다리는 최대 시간(초)입니다.

속성 값
Default value: 30
--patch --twin-patch

원하는 트윈 패치입니다. 파일 경로 또는 원시 json을 제공합니다.

--query-condition -q

디바이스가 작업을 실행할 수 있도록 하는 디바이스 쿼리 조건입니다. 작업 유형이 scheduleDeviceMethod 또는 scheduleUpdateTwin인 경우 필요합니다. 참고: 서비스는 입력에 "SELECT * FROM 디바이스 WHERE" 접두사를 추가합니다.

--resource-group -g

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

--start --start-time

ISO 8601 날짜 시간 형식으로 예약된 작업의 시작입니다. 시작 시간이 제공되지 않으면 작업을 최대한 빨리 실행하기 위해 큐에 대기합니다. 과거 사용자 지정 시작 시간을 사용하면 작업이 실패할 수 있습니다.

--ttl

작업이 종료되기 전의 최대 실행 시간(초)입니다.

속성 값
Default value: 3600
--wait -w

만든 작업이 완료, 실패 또는 취소된 상태가 될 때까지 차단합니다. --poll-interval으로 지정된 간격에 대해 정기적으로 폴링합니다.

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

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

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

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

--only-show-errors

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

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

Output format.

속성 값
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 job list

IoT Hub의 기록 작업을 나열합니다.

az iot hub job list [--auth-type {key, login}]
                    [--hub-name]
                    [--job-status --js {cancelled, completed, enqueued, failed, queued, running, scheduled, unknown}]
                    [--job-type --jt {export, import, scheduleDeviceMethod, scheduleUpdateTwin}]
                    [--login]
                    [--resource-group]
                    [--top]

예제

보존 기간(최대 30일) 내에 보관된 모든 작업을 나열합니다.

az iot hub job list --hub-name {iothub_name}

특정 속성을 프로젝팅하는 모든 보관된 작업 나열

az iot hub job list --hub-name {iothub_name} --query "[*].[jobId,type,status,startTime,endTime]"

쌍 형식 작업 업데이트만 나열

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod

상태가 "예약됨"인 디바이스 메서드 작업을 나열합니다.

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod --job-status scheduled

상태가 "완료됨"인 디바이스 내보내기 작업 나열

az iot hub job list --hub-name {iothub_name} --job-type export --job-status completed

선택적 매개 변수

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

--auth-type

작업에서 정책 키를 자동으로 파생할지 아니면 현재 Azure AD 세션을 사용해야 하는지 여부를 나타냅니다. 인증 유형이 로그인되고 리소스 호스트 이름이 제공되면 필요한 경우가 아니면 리소스 조회를 건너뜁습니다. az configure --defaults iothub-data-auth-type={auth-type-value}사용하여 기본값을 구성할 수 있습니다.

속성 값
Parameter group: Access Control Arguments
Default value: key
허용되는 값: key, login
--hub-name -n

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

속성 값
Parameter group: IoT Hub Identifier Arguments
--job-status --js

예약된 작업의 상태입니다.

속성 값
허용되는 값: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown
--job-type --jt

예약된 작업의 형식입니다.

속성 값
허용되는 값: export, import, scheduleDeviceMethod, scheduleUpdateTwin
--login -l

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

속성 값
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

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

--top

반환할 최대 요소 수입니다. 무제한으로 -1 사용합니다.

전역 매개 변수
--debug

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

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

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

--only-show-errors

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

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

Output format.

속성 값
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 job show

기존 IoT Hub 작업의 세부 정보를 표시합니다.

az iot hub job show --job-id
                    [--auth-type {key, login}]
                    [--hub-name]
                    [--login]
                    [--resource-group]

예제

만든 작업의 세부 정보를 표시합니다.

az iot hub job show --hub-name {iothub_name} --job-id {job_id}

필수 매개 변수

--job-id

IoT Hub 작업 ID입니다.

선택적 매개 변수

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

--auth-type

작업에서 정책 키를 자동으로 파생할지 아니면 현재 Azure AD 세션을 사용해야 하는지 여부를 나타냅니다. 인증 유형이 로그인되고 리소스 호스트 이름이 제공되면 필요한 경우가 아니면 리소스 조회를 건너뜁습니다. az configure --defaults iothub-data-auth-type={auth-type-value}사용하여 기본값을 구성할 수 있습니다.

속성 값
Parameter group: Access Control Arguments
Default value: key
허용되는 값: key, login
--hub-name -n

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

속성 값
Parameter group: IoT Hub Identifier Arguments
--login -l

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

속성 값
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

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

전역 매개 변수
--debug

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

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

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

--only-show-errors

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

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

Output format.

속성 값
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