az iot hub state

  • 실험적
  • 참조

참고 항목

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

이 명령 그룹은 실험적이며 개발 중입니다. 참조 및 지원 수준: https://aka.ms/CLI_refstatus

IoT Hub의 상태를 관리합니다.

자세한 내용은 aka.ms/aziotcli-iot-hub-state 참조하세요.

명령

Name Description 형식 상태
az iot hub state export

IoT Hub의 상태를 파일로 내보냅니다.

 내선 번호 실험적
az iot hub state import

파일에서 IoT Hub로 허브 상태를 가져옵니다.

 내선 번호 실험적
az iot hub state migrate

한 허브의 상태를 파일에 저장하지 않고 다른 허브로 마이그레이션합니다.

 내선 번호 실험적

az iot hub state export

실험적

명령 그룹 'IoT 허브 상태'는 실험적이며 개발 중입니다. 참조 및 지원 수준: https://aka.ms/CLI_refstatus

IoT Hub의 상태를 파일로 내보냅니다.

기본적으로 내보낸 상태에는 허브용 arm 템플릿, 허브 구성(ADM 구성 및 에지 배포 포함), 디바이스 정보(디바이스 ID, 디바이스 쌍, 모듈 ID 및 모듈 쌍 포함)가 포함됩니다.

자세한 내용은 aka.ms/aziotcli-iot-hub-state 참조하세요.

az iot hub state export --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

예제

지정된 허브의 지원되는 상태를 지정된 파일로 내보냅니다.

az iot hub state export -n {iothub_name} -f {state_filename}

지정된 허브의 지원되는 상태를 지정된 파일로 내보내고 파일 내용을 덮어씁니다.

az iot hub state export -n {iothub_name} -f {state_filename} -r

지정된 허브의 디바이스 및 구성만 지정된 파일로 내보냅니다.

az iot hub state export -n {iothub_name} -f {state_filename} --aspects devices configurations

필수 매개 변수

--state-file -f

상태 정보가 저장될 파일의 경로입니다.

선택적 매개 변수

--aspects

허브 측면(공백으로 구분).

허용되는 값: arm, configurations, devices
--auth-type

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

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

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

--login -l

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

--replace -r

이 플래그가 설정되면 명령은 출력 파일의 내용을 덮어씁니다.

기본값: False
--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 state import

실험적

명령 그룹 'IoT 허브 상태'는 실험적이며 개발 중입니다. 참조 및 지원 수준: https://aka.ms/CLI_refstatus

파일에서 IoT Hub로 허브 상태를 가져옵니다.

arm 측면을 지정하면 허브가 없으면 만들어집니다.

기본적으로 가져온 상태에는 허브용 arm 템플릿, 허브 구성(ADM 구성 및 에지 배포 포함), 디바이스 정보(디바이스 ID, 디바이스 쌍, 모듈 ID 및 모듈 쌍 포함)가 포함됩니다.

시스템 할당 ID 인증을 사용하는 가져온 엔드포인트의 경우 지정된 허브에 올바른 권한이 있어야 합니다. 그렇지 않으면 명령이 실패합니다.

프라이빗 엔드포인트는 가져오기 프로세스에서 무시됩니다.

자세한 내용은 aka.ms/aziotcli-iot-hub-state 참조하세요.

az iot hub state import --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

예제

지정된 파일에서 지정된 허브로 지원되는 상태를 가져옵니다.

az iot hub state import -n {iothub_name} -f {state_filename}

지정된 파일에서 지정된 허브로 지원되는 상태를 가져와서 허브의 이전 상태를 덮어씁니다. 새 상태가 업로드되기 전에 모든 인증서, 구성 및 디바이스가 삭제됩니다.

az iot hub state import -n {iothub_name} -f {state_filename} -r

지정된 파일에서 지정된 허브로 arm 템플릿만 가져옵니다. 새 허브가 없으면 새 허브를 만듭니다. 파일에는 디바이스 및 구성이 포함될 수 있지만 무시됩니다.

az iot hub state import -n {iothub_name} -g {resource_group} -f {state_filename} --aspects arm

지정된 파일에서 지정된 허브로 디바이스 및 구성만 가져옵니다. 새 허브가 없으면 새 허브가 만들어지지 않으며 명령이 실패합니다. 파일에는 arm 템플릿이 포함될 수 있지만 무시됩니다.

az iot hub state import -n {iothub_name} -f {state_filename} --aspects devices configurations

필수 매개 변수

--state-file -f

상태 정보가 저장될 파일의 경로입니다.

선택적 매개 변수

--aspects

허브 측면(공백으로 구분).

허용되는 값: arm, configurations, devices
--auth-type

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

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

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

--login -l

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

--replace -r

이 플래그가 설정되면 명령은 대상 허브의 현재 디바이스, 구성 및 인증서를 삭제합니다.

기본값: False
--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 state migrate

실험적

명령 그룹 'IoT 허브 상태'는 실험적이며 개발 중입니다. 참조 및 지원 수준: https://aka.ms/CLI_refstatus

한 허브의 상태를 파일에 저장하지 않고 다른 허브로 마이그레이션합니다.

arm 측면을 지정하면 허브가 없으면 만들어집니다.

기본적으로 마이그레이션된 상태에는 허브용 arm 템플릿, 허브 구성(ADM 구성 및 에지 배포 포함), 디바이스 정보(디바이스 ID, 디바이스 쌍, 모듈 ID 및 모듈 쌍 포함)가 포함됩니다.

시스템 할당 ID 인증을 사용하는 마이그레이션된 엔드포인트의 경우 지정된 허브에 올바른 권한이 있어야 합니다. 그렇지 않으면 명령이 실패합니다.

프라이빗 엔드포인트는 마이그레이션 프로세스에서 무시됩니다.

마이그레이션하는 데 문제가 있는 경우 내보내기 및 가져오기 명령을 사용하여 파일을 백업으로 만듭니다.

자세한 내용은 aka.ms/aziotcli-iot-hub-state 참조하세요.

az iot hub state migrate [--aspects {arm, configurations, devices}]
                         [--auth-type {key, login}]
                         [--destination-hub]
                         [--destination-hub-login]
                         [--destination-resource-group]
                         [--og]
                         [--oh]
                         [--ol]
                         [--replace]

예제

원본 허브의 지원되는 상태를 대상 허브로 마이그레이션합니다.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name}

원본 허브의 지원되는 상태를 대상 허브로 마이그레이션하고 허브의 이전 상태를 덮어씁니다. 대상 허브의 모든 인증서, 구성 및 디바이스는 새 상태가 업로드되기 전에 삭제됩니다.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} -r

원본 허브에서 대상 허브로 arm 템플릿만 마이그레이션합니다. 대상 허브가 없는 경우 새 허브를 만듭니다. 원본 허브에는 디바이스 및 구성이 포함될 수 있지만 무시됩니다.

az iot hub state migrate --destination-hub {dest_hub_name} --destination-resource-group {dest_hub_resource_group} --origin-hub {orig_hub_name} --aspects arm

원본 허브에서 대상 허브로 디바이스 및 구성만 마이그레이션합니다. 대상 허브가 존재하지 않고 명령이 실패하는 경우 새 허브를 만들지 않습니다. 원본 허브에 대한 arm 템플릿은 무시됩니다.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} --aspects devices configurations

선택적 매개 변수

--aspects

허브 측면(공백으로 구분).

허용되는 값: arm, configurations, devices
--auth-type

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

허용되는 값: key, login
기본값: key
--destination-hub --dh

원본 허브 상태가 복사될 IoT Hub의 이름입니다.

--destination-hub-login --dl

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

--destination-resource-group --dg

원본 허브 상태가 복사될 IoT Hub의 리소스 그룹 이름입니다. 제공되지 않으면 원본 IoT Hub의 리소스 그룹을 사용합니다.

--og --origin-resource-group

복사할 IoT Hub의 리소스 그룹 이름입니다.

--oh --origin-hub

복사할 IoT Hub의 이름입니다.

--ol --origin-hub-login

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

--replace -r

이 플래그가 설정되면 명령은 대상 허브의 현재 디바이스, 구성 및 인증서를 삭제합니다.

기본값: False
전역 매개 변수
--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를 사용합니다.