az iot adr ns policy

Замечание

Эта ссылка является частью расширения Azure-iot для Azure CLI (версия 2.67.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды политики az iot aot adr ns . Подробнее о расширениях.

Управление политиками пространства имен реестра устройств.

Команды

Имя Описание Тип Состояние
az iot adr ns policy activate-byor

Активируйте или обновите политику "Принести собственный корень" (BYOR) с подписанной цепочкой сертификатов.

 Extension GA
az iot adr ns policy create

Создайте политику для пространства имен реестра устройств.

 Extension GA
az iot adr ns policy delete

Удалите политику для пространства имен реестра устройств.

 Extension GA
az iot adr ns policy list

Список политик для пространств имен реестра устройств.

 Extension GA
az iot adr ns policy revoke-issuer

Отмените сертификат ЦС для политики пространства имен реестра устройств.

 Extension GA
az iot adr ns policy show

Отображение политики для пространства имен реестра устройств.

 Extension GA
az iot adr ns policy update

Обновите политику для пространства имен реестра устройств.

 Extension GA

az iot adr ns policy activate-byor

Активируйте или обновите политику "Принести собственный корень" (BYOR) с подписанной цепочкой сертификатов.

Эта команда активирует политику BYOR путем отправки подписанной цепочки сертификатов. Используйте это после создания политики с параметром --enable-byor и подписывание CSR (из политики show) с помощью ЦС.

Файл цепочки сертификатов должен быть в формате PEM и содержать:

  1. Подписанный сертификат (соответствующий CSR, созданной службой)
  2. Все промежуточные сертификаты ЦС
  3. При необходимости сертификат корневого ЦС

Сертификаты должны быть упорядочены от конечного к корневому каталогу.

Эта команда также используется для продления сертификата, когда состояние BYOR показывает "ActiveButPendingRenewal".

az iot adr ns policy activate-byor --ccf --certificate-chain-file
                                   --name --pn --policy-name
                                   --namespace --ns
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]

Примеры

Активация политики BYOR с помощью подписанной цепочки сертификатов

az iot adr ns policy activate-byor -n myPolicy --ns myNamespace -g myResourceGroup --certificate-chain-file ./signed-chain.pem

Обязательные параметры

--ccf --certificate-chain-file

Путь к PEM-файлу, содержаму цепочку подписанных сертификатов. Файл должен содержать подписанный сертификат (соответствующий CSR из отображения политики), за которым следует все промежуточные ЦС и при необходимости корневой ЦС. Сертификаты должны быть упорядочены от конечного к корневому каталогу.

--name --pn --policy-name -n

Имя политики.

--namespace --ns

Имя пространства имен реестра устройств.

--resource-group -g

Имя группы ресурсов. Вы можете настроить группу по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot adr ns policy create

Создайте политику для пространства имен реестра устройств.

По умолчанию политики используют управляемый службой ЦС. Чтобы использовать собственный ЦС (принести собственный корневой каталог), используйте параметр --enable-byor и активируйте политику с подписанным CSR с помощью активации-byor.

az iot adr ns policy create --name --pn --policy-name
                            --namespace --ns
                            --resource-group
                            [--acquire-policy-token]
                            [--cert-key-type {ECC, RSA}]
                            [--cert-subject]
                            [--cert-validity-days]
                            [--change-reference]
                            [--enable-byor {false, true}]
                            [--tags]

Примеры

Создайте базовую политику с субъектом по умолчанию, типом сертификата (ECC) и сроком действия.

az iot adr ns policy create -n myPolicy --ns myNamespace -g myResourceGroup

Создание политики с настраиваемым сроком действия

az iot adr ns policy create -n myPolicy --ns myNamespace -g myResourceGroup --cert-validity-days 30

Создание политики BYOR (добавление собственного корневого каталога)

az iot adr ns policy create -n myPolicy --ns myNamespace -g myResourceGroup --enable-byor
# After creation, retrieve the CSR from 'policy show' and sign it with your CA,
# then activate with 'az iot adr ns policy activate-byor'

Обязательные параметры

--name --pn --policy-name -n

Имя политики.

--namespace --ns

Имя пространства имен реестра устройств.

--resource-group -g

Имя группы ресурсов. Вы можете настроить группу по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--cert-key-type

Тип ключа центра сертификации политики.

Свойство Значение
Группа параметров: Policy Certificate Arguments
Допустимые значения: ECC, RSA
--cert-subject

Субъект сертификата политики.

Свойство Значение
Группа параметров: Policy Certificate Arguments
--cert-validity-days

Срок действия сертификата политики в днях.

Свойство Значение
Группа параметров: Policy Certificate Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--enable-byor

Включите собственный корневой режим (BYOR) для политики. При включении необходимо подписать созданный службой CSR с помощью собственного ЦС и активировать с помощью az iot adr ns policy activate-byor. Это невозможно изменить после создания политики.

Свойство Значение
Группа параметров: Bring Your Own Root Arguments
Допустимые значения: false, true
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot adr ns policy delete

Удалите политику для пространства имен реестра устройств.

az iot adr ns policy delete --name --pn --policy-name
                            --namespace --ns
                            --resource-group
                            [--acquire-policy-token]
                            [--change-reference]
                            [--yes {false, true}]

Примеры

Удалите политику

az iot adr ns policy delete -n myPolicy --ns myNamespace -g myResourceGroup

Обязательные параметры

--name --pn --policy-name -n

Имя политики.

--namespace --ns

Имя пространства имен реестра устройств.

--resource-group -g

Имя группы ресурсов. Вы можете настроить группу по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--yes -y

Пропустить запросы пользователей. Указывает на принятие действия. Используется в основном для сценариев автоматизации. По умолчанию: false.

Свойство Значение
Допустимые значения: false, true
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot adr ns policy list

Список политик для пространств имен реестра устройств.

az iot adr ns policy list --namespace --ns
                          --resource-group

Примеры

Перечисление политик для пространства имен

az iot adr ns policy list --ns myNamespace -g myResourceGroup

Обязательные параметры

--namespace --ns

Имя пространства имен реестра устройств.

--resource-group -g

Имя группы ресурсов. Вы можете настроить группу по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot adr ns policy revoke-issuer

Отмените сертификат ЦС для политики пространства имен реестра устройств.

Эта команда отменяет текущий сертификат ЦС (издателя) для политики, активируя службу для создания нового сертификата ЦС. Все учетные данные устройства, выданные старым ЦС, должны быть повторно выданы. Используйте это, если сертификат ЦС скомпрометирован или требует смены.

az iot adr ns policy revoke-issuer --name --pn --policy-name
                                   --namespace --ns
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--yes {false, true}]

Примеры

Отзыв сертификата издателя для политики

az iot adr ns policy revoke-issuer -n myPolicy --ns myNamespace -g myResourceGroup

Обязательные параметры

--name --pn --policy-name -n

Имя политики.

--namespace --ns

Имя пространства имен реестра устройств.

--resource-group -g

Имя группы ресурсов. Вы можете настроить группу по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--yes -y

Пропустить запросы пользователей. Указывает на принятие действия. Используется в основном для сценариев автоматизации. По умолчанию: false.

Свойство Значение
Допустимые значения: false, true
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot adr ns policy show

Отображение политики для пространства имен реестра устройств.

Для политик BYOR (Перенос собственного корня) выходные данные включают запрос на подпись сертификата (CSR), который должен быть подписан центром сертификации.

az iot adr ns policy show --name --pn --policy-name
                          --namespace --ns
                          --resource-group

Примеры

Отображение сведений о политике

az iot adr ns policy show -n myPolicy --ns myNamespace -g myResourceGroup

Обязательные параметры

--name --pn --policy-name -n

Имя политики.

--namespace --ns

Имя пространства имен реестра устройств.

--resource-group -g

Имя группы ресурсов. Вы можете настроить группу по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot adr ns policy update

Обновите политику для пространства имен реестра устройств.

az iot adr ns policy update --name --pn --policy-name
                            --namespace --ns
                            --resource-group
                            [--acquire-policy-token]
                            [--cert-validity-days]
                            [--change-reference]
                            [--tags]

Примеры

Обновление срока действия сертификата

az iot adr ns policy update -n myPolicy --cert-validity-days 10 --ns myNamespace -g myResourceGroup

Обязательные параметры

--name --pn --policy-name -n

Имя политики.

--namespace --ns

Имя пространства имен реестра устройств.

--resource-group -g

Имя группы ресурсов. Вы можете настроить группу по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--cert-validity-days

Срок действия сертификата политики в днях.

Свойство Значение
Группа параметров: Policy Certificate Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False