az iot hub job

참고

이 참조는 Azure CLI에 대 한 azure iot 확장의 일부 이며 버전 2.17.1 이상 이어야 합니다. 확장은 az iot hub job 명령을 처음 실행할 때 자동으로 설치 됩니다. 확장에 대해 자세히 알아보세요.

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

명령

az iot hub job cancel

IoT Hub 작업을 취소 합니다.

az iot hub job create

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

az iot hub job list

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

az iot hub job show

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

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

작업 Id를 IoT Hub 합니다.

선택적 매개 변수

--auth-type

작업에서 정책 키를 자동으로 파생 시키거나 현재 Azure AD 세션을 사용할지 여부를 나타냅니다. 를 사용 하 여 기본값을 구성할 수 있습니다 az configure --defaults iothub-data-auth-type=<auth-type-value> .

허용되는 값: key, login
기본값: key
--hub-name -n

IoT Hub 이름입니다.

--login -l

이 명령은 작업을 수행할 수 있는 권한이 있는 엔터티 연결 문자열을 지원 합니다. "Az login"을 통해 세션 로그인을 방지 하는 데 사용 합니다. 엔터티 연결 문자열과 이름을 모두 제공 하는 경우 연결 문자열에 우선 순위가 적용 됩니다.

--resource-group -g

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

az iot hub job create

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

쌍 업데이트 작업을 예약할 때 쌍 패치는 필수 인수입니다. 장치 메서드 작업을 예약할 때 메서드 이름 및 페이로드는 필수 인수입니다.

az iot hub job create --job-id
                      --job-type {scheduleDeviceMethod, scheduleUpdateTwin}
                      [--auth-type {key, login}]
                      [--duration]
                      [--hub-name]
                      [--interval]
                      [--login]
                      [--mct]
                      [--method-name]
                      [--method-payload]
                      [--method-response-timeout]
                      [--patch]
                      [--query-condition]
                      [--resource-group]
                      [--start]
                      [--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 "2020-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

작업 Id를 IoT Hub 합니다.

--job-type --jt

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

허용되는 값: scheduleDeviceMethod, scheduleUpdateTwin

선택적 매개 변수

--auth-type

작업에서 정책 키를 자동으로 파생 시키거나 현재 Azure AD 세션을 사용할지 여부를 나타냅니다. 를 사용 하 여 기본값을 구성할 수 있습니다 az configure --defaults iothub-data-auth-type=<auth-type-value> .

허용되는 값: key, login
기본값: key
--duration --poll-duration

--Wait 플래그가 전달 된 경우 작업 상태를 확인 하는 총 기간 (초)입니다.

기본값: 600
--hub-name -n

IoT Hub 이름입니다.

--interval --poll-interval

--Wait 플래그가 전달 된 경우 작업 상태를 확인 하는 간격 (초)입니다.

기본값: 10
--login -l

이 명령은 작업을 수행할 수 있는 권한이 있는 엔터티 연결 문자열을 지원 합니다. "Az login"을 통해 세션 로그인을 방지 하는 데 사용 합니다. 엔터티 연결 문자열과 이름을 모두 제공 하는 경우 연결 문자열에 우선 순위가 적용 됩니다.

--mct --method-connect-timeout

장치 연결을 대기 하는 최대 시간 (초)입니다.

기본값: 30
--method-name --mn

호출할 대상 메서드입니다.

--method-payload --mp

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

--method-response-timeout --mrt

장치 메서드 결과를 대기 하는 최대 시간 (초)입니다.

기본값: 30
--patch --twin-patch

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

--query-condition -q

작업을 실행할 장치를 가져올 장치 쿼리 조건입니다. 작업 유형이 scheduleDeviceMethod 또는 scheduleUpdateTwin 인 경우 필수입니다. 참고: 서비스는 입력에 "SELECT * FROM devices" 접두사를 붙입니다.

--resource-group -g

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

--start --start-time

ISO 8601 날짜/시간 형식으로 예약 된 작업 시작입니다. 시작 시간이 지정 되지 않은 경우 작업은 asap 실행을 위해 큐에 대기 됩니다.

--ttl

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

기본값: 3600
--wait -w

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

허용되는 값: false, true

az iot hub job list

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

az iot hub job list [--auth-type {key, login}]
                    [--hub-name]
                    [--job-status {cancelled, completed, enqueued, failed, queued, running, scheduled, unknown}]
                    [--job-type {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

선택적 매개 변수

--auth-type

작업에서 정책 키를 자동으로 파생 시키거나 현재 Azure AD 세션을 사용할지 여부를 나타냅니다. 를 사용 하 여 기본값을 구성할 수 있습니다 az configure --defaults iothub-data-auth-type=<auth-type-value> .

허용되는 값: key, login
기본값: key
--hub-name -n

IoT Hub 이름입니다.

--job-status --js

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

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

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

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

이 명령은 작업을 수행할 수 있는 권한이 있는 엔터티 연결 문자열을 지원 합니다. "Az login"을 통해 세션 로그인을 방지 하는 데 사용 합니다. 엔터티 연결 문자열과 이름을 모두 제공 하는 경우 연결 문자열에 우선 순위가 적용 됩니다.

--resource-group -g

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

--top

반환할 최대 요소 수입니다. 무제한의 경우-1을 사용 합니다.

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

작업 Id를 IoT Hub 합니다.

선택적 매개 변수

--auth-type

작업에서 정책 키를 자동으로 파생 시키거나 현재 Azure AD 세션을 사용할지 여부를 나타냅니다. 를 사용 하 여 기본값을 구성할 수 있습니다 az configure --defaults iothub-data-auth-type=<auth-type-value> .

허용되는 값: key, login
기본값: key
--hub-name -n

IoT Hub 이름입니다.

--login -l

이 명령은 작업을 수행할 수 있는 권한이 있는 엔터티 연결 문자열을 지원 합니다. "Az login"을 통해 세션 로그인을 방지 하는 데 사용 합니다. 엔터티 연결 문자열과 이름을 모두 제공 하는 경우 연결 문자열에 우선 순위가 적용 됩니다.

--resource-group -g

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