az iot hub module-identity

참고 항목

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

IoT 디바이스 모듈을 관리합니다.

명령

Name	Description	형식	상태
az iot hub module-identity connection-string	IoT 디바이스 모듈의 연결 문자열 관리합니다.	내선 번호	GA
az iot hub module-identity connection-string show	대상 IoT 디바이스 모듈 연결 문자열 표시합니다.	내선 번호	GA
az iot hub module-identity create	IoT Hub의 대상 IoT 디바이스에 모듈을 만듭니다.	내선 번호	GA
az iot hub module-identity delete	IoT Hub에서 디바이스를 삭제합니다.	내선 번호	GA
az iot hub module-identity list	IoT Hub의 IoT 디바이스에 있는 모듈을 나열합니다.	내선 번호	GA
az iot hub module-identity renew-key	sas 인증을 사용하여 IoT Hub 디바이스 모듈의 대상 키를 갱신합니다.	내선 번호	GA
az iot hub module-identity show	IoT Hub에서 IoT 디바이스 모듈의 세부 정보를 가져옵니다.	내선 번호	GA
az iot hub module-identity update	IoT Hub 디바이스 모듈을 업데이트합니다.	내선 번호	GA

az iot hub module-identity create

IoT Hub의 대상 IoT 디바이스에 모듈을 만듭니다.

shared_private_key 인증 방법(대칭 키라고도 함)을 사용하는 경우 사용자 지정 키가 제공되지 않으면 서비스에서 모듈에 대해 생성합니다.

az iot hub module-identity create --device-id
                                  --module-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--valid-days]

필수 매개 변수

--device-id -d

대상 디바이스 ID입니다.

--module-id -m

대상 모듈 ID입니다.

선택적 매개 변수

--am --auth-method

엔터티를 만들 권한 부여 메서드입니다.

허용되는 값: shared_private_key, x509_ca, x509_thumbprint

Default value: shared_private_key

--auth-type

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

허용되는 값: key, login

Default value: key

--hub-name -n

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

--login -l

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

--od --output-dir

자체 서명된 인증서를 생성하고 지문을 사용합니다. 지정된 대상 디렉터리에 출력합니다.

--pk --primary-key

base64 형식으로 저장된 기본 대칭 공유 액세스 키입니다.

--primary-thumbprint --ptp

기본 지문에 사용할 자체 서명된 인증서 지문입니다.

--resource-group -g

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

--secondary-key --sk

base64 형식으로 저장된 보조 대칭 공유 액세스 키입니다.

--secondary-thumbprint --stp

보조 지문에 사용할 자체 서명된 인증서 지문입니다.

--valid-days --vd

자체 서명된 인증서를 생성하고 지문을 사용합니다. 지정된 일 수에 유효합니다. 기본값: 365.

전역 매개 변수

--debug

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

--help -h

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

--only-show-errors

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

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub module-identity delete

IoT Hub에서 디바이스를 삭제합니다.

az iot hub module-identity delete --device-id
                                  --module-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

필수 매개 변수

--device-id -d

대상 디바이스 ID입니다.

--module-id -m

대상 모듈 ID입니다.

선택적 매개 변수

--auth-type

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

허용되는 값: key, login

Default value: key

--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

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub module-identity list

IoT Hub의 IoT 디바이스에 있는 모듈을 나열합니다.

az iot hub module-identity list --device-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

필수 매개 변수

--device-id -d

대상 디바이스 ID입니다.

선택적 매개 변수

--auth-type

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

허용되는 값: key, login

Default value: key

--hub-name -n

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

--login -l

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

--resource-group -g

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

--top

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

Default value: 1000

전역 매개 변수

--debug

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

--help -h

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

--only-show-errors

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

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub module-identity renew-key

sas 인증을 사용하여 IoT Hub 디바이스 모듈의 대상 키를 갱신합니다.

az iot hub module-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     --module-id
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--resource-group]

예제

기본 키를 갱신합니다.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt primary

기본 키와 보조 키를 교환합니다.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt swap

필수 매개 변수

--device-id -d

대상 디바이스 ID입니다.

--hub-name -n

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

--key-type --kt

다시 생성할 대상 키 형식입니다.

허용되는 값: primary, secondary, swap

--module-id -m

대상 모듈 ID입니다.

선택적 매개 변수

--auth-type

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

허용되는 값: key, login

Default value: key

--etag -e

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

--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

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub module-identity show

IoT Hub에서 IoT 디바이스 모듈의 세부 정보를 가져옵니다.

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

필수 매개 변수

--device-id -d

대상 디바이스 ID입니다.

--module-id -m

대상 모듈 ID입니다.

선택적 매개 변수

--auth-type

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

허용되는 값: key, login

Default value: key

--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

Default value: json

--query

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

--subscription

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

--verbose

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

az iot hub module-identity update

IoT Hub 디바이스 모듈을 업데이트합니다.

모듈을 업데이트하기 위해 --set 다음에 속성 할당을 사용합니다. 'iot hub module-identity show'에서 반환된 속성을 활용합니다.

az iot hub module-identity update --device-id
                                  --module-id
                                  [--add]
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--remove]
                                  [--resource-group]
                                  [--set]

예제

모듈 대칭 인증 키 다시 생성

az iot hub module-identity update -m {module_name} -d {device_id} -n {iothub_name} --set authentication.symmetricKey.primaryKey="" authentication.symmetricKey.secondaryKey=""

필수 매개 변수

--device-id -d

대상 디바이스 ID입니다.

--module-id -m

대상 모듈 ID입니다.

선택적 매개 변수

--add

경로 및 키 값 쌍을 지정하여 개체 목록에 개체를 추가합니다. 예: --add property.listProperty <key=value, string or JSON string>

Default value: []

--auth-type

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

허용되는 값: key, login

Default value: key

--etag -e

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

--force-string

'set' 또는 'add'를 사용하는 경우 JSON으로 변환하는 대신 문자열 리터럴을 유지합니다.

Default value: False

--hub-name -n

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

--login -l

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

--remove

목록에서 속성 또는 요소를 제거합니다. 예: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []

--resource-group -g

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

--set

설정할 속성 경로와 값을 지정하여 개체를 업데이트합니다. 예: --set property1.property2=<value>

Default value: []

전역 매개 변수

--debug

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

--help -h

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

--only-show-errors

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

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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