az iot hub configuration

참고 항목

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

대규모로 IoT 자동 디바이스 관리 구성을 관리합니다.

명령

Name	Description	형식	상태
az iot hub configuration create	대상 IoT Hub에서 IoT 자동 디바이스 관리 구성을 만듭니다.	내선 번호	GA
az iot hub configuration delete	IoT 디바이스 구성을 삭제합니다.	내선 번호	GA
az iot hub configuration list	IoT Hub에서 IoT 자동 디바이스 관리 구성을 나열합니다.	내선 번호	GA
az iot hub configuration show	IoT 자동 디바이스 관리 구성의 세부 정보를 가져옵니다.	내선 번호	GA
az iot hub configuration show-metric	IoT 디바이스 구성에 정의된 대상 사용자 또는 시스템 메트릭을 평가합니다.	내선 번호	GA
az iot hub configuration update	IoT 자동 디바이스 관리 구성의 지정된 속성을 업데이트합니다.	내선 번호	GA

az iot hub configuration create

대상 IoT Hub에서 IoT 자동 디바이스 관리 구성을 만듭니다.

구성 콘텐츠는 json이며 디바이스 또는 모듈 의도에 따라 약간 다릅니다.

디바이스 구성은 {"deviceContent":{...}} 형식입니다. 또는 {"content":{"deviceContent":{...}}}

모듈 구성은 {"moduleContent":{...}} 형식입니다. 또는 {"content":{"moduleContent":{...}}}

주문형 평가를 위해 사용자가 제공한 메트릭을 사용하여 구성을 정의할 수 있습니다. 사용자 메트릭은 json이며 {"쿼리":{...}} 형식입니다. 또는 {"metrics":{"queries":{...}}}입니다.

참고: 모듈의 대상 조건은 "from devices.modules where"로 시작해야 합니다.

az iot hub configuration create --config-id
                                --content
                                [--auth-type {key, login}]
                                [--cl]
                                [--cmq]
                                [--hub-name]
                                [--lab]
                                [--login]
                                [--metrics]
                                [--pri]
                                [--resource-group]
                                [--target-condition]

예제

빌드 9에서 디바이스에 태그가 지정되고 환경이 '테스트'인 경우 조건에 적용되는 우선 순위가 3인 디바이스 구성을 만듭니다.

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9 and tags.environment='test'" --priority 3

레이블이 있는 디바이스 구성을 만들고 사용자 메트릭 인라인을 제공합니다(bash 구문 예제).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9" --labels '{"key0":"value0", "key1":"value1"}' --priority 10 --metrics '{"metrics": {"queries": {"mymetric": "select deviceId from devices where tags.location='US'"}}}'

레이블을 사용하여 모듈 구성을 만들고 사용자 메트릭 인라인 제공(cmd 구문 예제)

az iot hub configuration create -c {config_name} -n {iothub_name} --content module_content.json --target-condition "from devices.modules where tags.building=9" --labels "{\"key0\":\"value0\", \"key1\":\"value1\"}" --metrics "{\"metrics\": {\"queries\": {\"mymetric\": \"select moduleId from devices.modules where tags.location='US'\"}}}"

콘텐츠 및 사용자 메트릭 인라인으로 모듈 구성을 만듭니다(powershell 구문 예제).

az iot hub configuration create -c {config_name} -n {iothub_name} --content '{\"moduleContent\": {\"properties.desired.chillerWaterSettings\": {\"temperature\": 38, \"pressure\": 78}}}' --target-condition "from devices.modules where tags.building=9" --priority 1 --metrics '{\"metrics\": {\"queries\": {\"mymetric\":\"select moduleId from devices.modules where tags.location=''US''\"}}}'

레이블 및 메트릭의 대체 입력 스타일(셸에 구애받지 않은)으로 디바이스 구성을 만듭니다.

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "from devices.modules where tags.building=9" --custom-labels key0="value0" key1="value1" --priority 10 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

필수 매개 변수

--config-id -c

대상 디바이스 구성 이름입니다. 소문자와 다음 특수 문자가 허용됩니다. [-+%_*!'].

--content -k

디바이스 구성 콘텐츠입니다. 파일 경로 또는 원시 json을 제공합니다.

선택적 매개 변수

--auth-type

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

허용되는 값: key, login

Default value: key

--cl --custom-labels

--labels에 대한 대체 입력 스타일(공백으로 구분된 키=값 쌍)이며 나중에 바꾸기 위한 것입니다. 형식 예제: key1=value1 key2="this is my value".

--cmq --custom-metric-queries

--metrics에 대한 대체 입력 스타일(공백으로 구분된 키=값 쌍)이며 나중에 대체합니다. 형식 예제: metric1="tags.location='US'" metric2="select *"인 디바이스에서 deviceId를 선택합니다.

--hub-name -n

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

--lab --labels

대상 구성에 적용할 레이블의 맵입니다. --label 대신 --custom-labels를 사용하는 것이 좋습니다. 형식 예제: {"key0":"value0", "key1":"value1"}.

--login -l

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

--metrics -m

디바이스 구성 메트릭 정의. 파일 경로 또는 원시 json을 제공합니다. --metrics 대신 --custom-metric-queries를 사용하는 것이 좋습니다.

--pri --priority

경쟁 규칙(가장 높은 우선)의 경우 디바이스 구성의 가중치입니다.

Default value: 0

--resource-group -g

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

--target-condition --tc -t

디바이스 또는 모듈 구성이 적용되는 대상 조건입니다. 대상 조건이 없는 구성은 디바이스 또는 모듈을 대상으로 하지 않습니다. "tags.environment='test'" 형식을 사용합니다.

전역 매개 변수

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

IoT 디바이스 구성을 삭제합니다.

az iot hub configuration delete --config-id
                                [--auth-type {key, login}]
                                [--etag]
                                [--hub-name]
                                [--login]
                                [--resource-group]

필수 매개 변수

--config-id -c

대상 디바이스 구성 이름입니다. 소문자와 다음 특수 문자가 허용됩니다. [-+%_*!'].

선택적 매개 변수

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

IoT Hub에서 IoT 자동 디바이스 관리 구성을 나열합니다.

az iot hub configuration list [--auth-type {key, login}]
                              [--hub-name]
                              [--login]
                              [--resource-group]
                              [--top]

선택적 매개 변수

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

반환할 최대 구성 수입니다. 기본적으로 모든 구성이 반환됩니다.

전역 매개 변수

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

IoT 자동 디바이스 관리 구성의 세부 정보를 가져옵니다.

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

필수 매개 변수

--config-id -c

대상 디바이스 구성 이름입니다. 소문자와 다음 특수 문자가 허용됩니다. [-+%_*!'].

선택적 매개 변수

--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 configuration show-metric

IoT 디바이스 구성에 정의된 대상 사용자 또는 시스템 메트릭을 평가합니다.

az iot hub configuration show-metric --config-id
                                     --metric-id
                                     [--auth-type {key, login}]
                                     [--hub-name]
                                     [--login]
                                     [--metric-type {system, user}]
                                     [--resource-group]

예제

사용자 정의 'warningLimit' 메트릭 평가

az iot hub configuration show-metric -m warningLimit -c {configuration_name} -n {iothub_name}

시스템 'appliedCount' 메트릭 평가

az iot hub configuration show-metric --metric-id appliedCount -c {configuration_name} -n {iothub_name} --metric-type system

필수 매개 변수

--config-id -c

대상 디바이스 구성 이름입니다. 소문자와 다음 특수 문자가 허용됩니다. [-+%_*!'].

--metric-id -m

평가를 위한 대상 메트릭입니다.

선택적 매개 변수

--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이 제공되지 않은 경우 필요합니다.

--metric-type --mt

메트릭을 조회하는 데 사용해야 하는 메트릭 컬렉션을 나타냅니다.

허용되는 값: system, user

Default value: user

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

IoT 자동 디바이스 관리 구성의 지정된 속성을 업데이트합니다.

구성을 업데이트하기 위해 --set 다음에 속성 할당을 사용합니다.

참고: 구성 콘텐츠는 변경할 수 없습니다. 업데이트할 수 있는 구성 속성은 '레이블', '메트릭', '우선 순위' 및 'targetCondition'입니다.

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

예제

디바이스 구성의 우선 순위 변경 및 대상 조건 업데이트

az iot hub configuration update -c {configuration_name} -n {iothub_name} --set priority=10 targetCondition="tags.building=43 and tags.environment='dev'"

필수 매개 변수

--config-id -c

대상 디바이스 구성 이름입니다. 소문자와 다음 특수 문자가 허용됩니다. [-+%_*!'].

선택적 매개 변수

--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를 사용합니다.