az iot ops connector template

Замечание

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

Управление шаблонами соединителя.

Шаблоны соединителей предоставляют стандартный подход на основе метаданных к развертыванию соединителя. Шаблоны создаются из ссылок на метаданные соединителей (MCR для 1-сторонних соединителей, ACR для 3-сторонних соединителей), автоматически заполняя конфигурацию соединителя, позволяя настраивать параметры развертывания пользователем.

Команды

Имя Описание Тип Состояние
az iot ops connector template create

Создайте шаблон соединителя.

 Расширение GA
az iot ops connector template delete

Удаление шаблона соединителя.

 Расширение GA
az iot ops connector template list

Список всех шаблонов соединителей.

 Расширение GA
az iot ops connector template show

Отображение шаблона соединителя.

 Расширение GA
az iot ops connector template update

Обновите существующий шаблон соединителя.

 Расширение GA

az iot ops connector template create

Создайте шаблон соединителя.

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

az iot ops connector template create --connector-metadata-ref --ref
                                     --instance
                                     --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--allocation-policy --ap]
                                     [--bs --bucket-size]
                                     [--cc --connector-config]
                                     [--change-reference]
                                     [--image-pull-policy --ipp]
                                     [--image-pull-secrets --ips]
                                     [--ll --log-level]
                                     [--replicas]
                                     [--secrets]
                                     [--storage-volumes --sv]
                                     [--trust-settings-secret-ref --tssr]

Примеры

Создайте шаблон для соединителя REST с параметрами по умолчанию.

az iot ops connector template create --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:1.0.6

Создайте шаблон с настраиваемой конфигурацией.

az iot ops connector template create --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:1.0.6 --replicas 3 --log-level debug --image-pull-secrets acr-credentials

Создайте шаблон для стороннего соединителя из частного ACR.

az iot ops connector template create --name custom-plc-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref contoso.azurecr.io/connectors/plc-metadata:1.0.0 --image-pull-secrets acr-pull-secret

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

--connector-metadata-ref --ref

URL-адрес артефакта метаданных соединителя из реестра контейнеров.

            1st-party connectors (MCR):
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/media-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/mqtt-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/sse-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/onvif-metadata:VERSION`

            3rd-party connectors:
            - `REGISTRY.azurecr.io/PATH-metadata:VERSION`

            To list available versions for 1st-party connectors:
            `curl https://mcr.microsoft.com/v2/azureiotoperations/akri-connectors/TYPE-metadata/tags/list`.
--instance -i

Имя экземпляра операций Интернета вещей.

--name -n

Имя шаблона.

--resource-group -g

Группа ресурсов экземпляра.

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

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

--acquire-policy-token

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

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

Политика выделения конечных точек устройства между экземплярами соединителя (без учета регистра). Параметры: сегментизованные. Если это не указано, политика выделения не будет задана.

--bs --bucket-size

Количество конечных точек на контейнер экземпляра соединителя. Требуется, если политика выделения имеет значение Bucketized.

--cc --connector-config

Конфигурации, разделенные по пространству, зависят от соединителя. Формат: key=value. Может предоставлять несколько значений в одном вызове или использовать несколько раз. Примеры: --cc brokerAddress=mqtt://broker:1883 qos=1 keepAlive=60 OR --cc brokerAddress=mqtt://broker:1883 --cc qos=1 --cc keepAlive=60. Используйте "" для очистки существующих конфигураций.

--change-reference

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

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

Политика извлечения изображений Kubernetes. Параметры: Always, IfNotPresent, Никогда.

--image-pull-secrets --ips

Разделенные пробелами имена секретов Kubernetes для извлечения образов контейнеров из частных реестров. Для сторонних соединителей с помощью частного реестра контейнеров укажите секреты, содержащие учетные данные реестра, чтобы модуль pod соединителя мог извлечь образ. Используйте "" для очистки существующих секретов извлечения изображений.

--ll --log-level

Уровень журнала для модулей pod соединителя. Параметры: трассировка, отладка, информация, предупреждение, ошибка. Значение по умолчанию: сведения.

--replicas -r

Количество реплик модулей pod соединителя для развертывания. Значение по умолчанию принимается из рекомендуемыхreplicas в метаданных или 1, если не указано.

--secrets

Секреты приложения соединителя с разделимы пробелами для подключения в формате key=value. Для каждого секрета требуется три поля: secretRef (имя секрета для подключения), secretKey (ключ в подключенном секрете) и secretAlias (псевдоним приложения). Пример: secretRef=mySecret secretKey=password secretAlias=dbPassword. Можно использовать несколько раз для определения нескольких секретов. SecretRef должен ссылаться на секрет, синхронизированный с помощью класса поставщика секретов. Используйте "" для очистки существующих секретов.

--storage-volumes --sv

Ссылка на утверждение постоянного тома в формате key=value, разделенная пробелами. Обязательные ключи: claimName (имя существующего ПВХ), mountPath (путь подключения в контейнере). Пример: claimName=myPVC mountPath=/data. Используйте "" для очистки существующих томов хранилища.

--trust-settings-secret-ref --tssr

Секретная ссылка на сертификаты для доверия. Это указывает имя секрета Kubernetes, содержащего доверенные сертификаты ЦС. Используйте "" для очистки существующих параметров доверия.

Глобальные параметры
--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 ops connector template delete

Удаление шаблона соединителя.

Удаляет шаблон соединителя. Проверяет, используется ли шаблон развернутыми соединителями и запрашивает подтверждение, если не указано --yes.

az iot ops connector template delete --instance
                                     --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--change-reference]
                                     [--yes {false, true}]

Примеры

Удалите шаблон с запросом подтверждения.

az iot ops connector template delete --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance

Удалите шаблон без подтверждения.

az iot ops connector template delete --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --yes

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

--instance -i

Имя экземпляра операций Интернета вещей.

--name -n

Имя шаблона.

--resource-group -g

Группа ресурсов экземпляра.

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

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

--acquire-policy-token

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

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

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

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

Подтвердите [y]es без запроса. Полезно для сценариев CI и автоматизации.

Свойство Значение
Default value: 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 ops connector template list

Список всех шаблонов соединителей.

Перечисляет все шаблоны соединителей для конкретного экземпляра Операции Интернета вещей Azure с сводными сведениями, включая имя шаблона, тип соединителя, версию, реплики и даты создания и изменения.

az iot ops connector template list --instance
                                   --resource-group

Примеры

Список всех шаблонов для экземпляра.

az iot ops connector template list --resource-group myResourceGroup --instance myAIOInstance

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

--instance -i

Имя экземпляра операций Интернета вещей.

--resource-group -g

Группа ресурсов экземпляра.

Глобальные параметры
--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 ops connector template show

Отображение шаблона соединителя.

Отображает полную конфигурацию шаблона, включая метаданные, сведения о соединителе, конфигурацию образа, параметры развертывания, storage конфигурацию и параметры безопасности.

az iot ops connector template show --instance
                                   --name
                                   --resource-group

Примеры

Отображение сведений о шаблоне в формате JSON.

az iot ops connector template show --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance

Отображение шаблона в формате таблицы.

az iot ops connector template show --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --output table

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

--instance -i

Имя экземпляра операций Интернета вещей.

--name -n

Имя шаблона.

--resource-group -g

Группа ресурсов экземпляра.

Глобальные параметры
--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 ops connector template update

Обновите существующий шаблон соединителя.

Обновляет шаблон соединителя. Можно изменить такие параметры развертывания, как реплики, уровни журналов, секреты, параметры извлечения изображений и параметры доверия. Метаданные соединителя можно обновлять только до обновлений исправлений или дополнительных версий. Обновления основной версии требуют создания нового шаблона.

az iot ops connector template update --instance
                                     --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--allocation-policy --ap]
                                     [--bs --bucket-size]
                                     [--cc --connector-config]
                                     [--change-reference]
                                     [--connector-metadata-ref --ref]
                                     [--image-pull-policy --ipp]
                                     [--image-pull-secrets --ips]
                                     [--ll --log-level]
                                     [--replicas]
                                     [--secrets]
                                     [--storage-volumes --sv]
                                     [--trust-settings-secret-ref --tssr]

Примеры

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

az iot ops connector template update --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --replicas 5 --log-level debug

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

az iot ops connector template update --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:1.0.7

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

--instance -i

Имя экземпляра операций Интернета вещей.

--name -n

Имя шаблона.

--resource-group -g

Группа ресурсов экземпляра.

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

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

--acquire-policy-token

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

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

Политика выделения конечных точек устройства между экземплярами соединителя (без учета регистра). Параметры: сегментизованные. Если это не указано, политика выделения не будет задана.

--bs --bucket-size

Количество конечных точек на контейнер экземпляра соединителя. Требуется, если политика выделения имеет значение Bucketized.

--cc --connector-config

Конфигурации, разделенные по пространству, зависят от соединителя. Формат: key=value. Может предоставлять несколько значений в одном вызове или использовать несколько раз. Примеры: --cc brokerAddress=mqtt://broker:1883 qos=1 keepAlive=60 OR --cc brokerAddress=mqtt://broker:1883 --cc qos=1 --cc keepAlive=60. Используйте "" для очистки существующих конфигураций.

--change-reference

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

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

URL-адрес артефакта метаданных соединителя из реестра контейнеров.

            1st-party connectors (MCR):
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/media-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/mqtt-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/sse-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/onvif-metadata:VERSION`

            3rd-party connectors:
            - `REGISTRY.azurecr.io/PATH-metadata:VERSION`

            To list available versions for 1st-party connectors:
            `curl https://mcr.microsoft.com/v2/azureiotoperations/akri-connectors/TYPE-metadata/tags/list`.
--image-pull-policy --ipp

Политика извлечения изображений Kubernetes. Параметры: Always, IfNotPresent, Никогда.

--image-pull-secrets --ips

Разделенные пробелами имена секретов Kubernetes для извлечения образов контейнеров из частных реестров. Для сторонних соединителей с помощью частного реестра контейнеров укажите секреты, содержащие учетные данные реестра, чтобы модуль pod соединителя мог извлечь образ. Используйте "" для очистки существующих секретов извлечения изображений.

--ll --log-level

Уровень журнала для модулей pod соединителя. Параметры: трассировка, отладка, информация, предупреждение, ошибка. Значение по умолчанию: сведения.

--replicas -r

Количество реплик модулей pod соединителя для развертывания. Значение по умолчанию принимается из рекомендуемыхreplicas в метаданных или 1, если не указано.

--secrets

Секреты приложения соединителя с разделимы пробелами для подключения в формате key=value. Для каждого секрета требуется три поля: secretRef (имя секрета для подключения), secretKey (ключ в подключенном секрете) и secretAlias (псевдоним приложения). Пример: secretRef=mySecret secretKey=password secretAlias=dbPassword. Можно использовать несколько раз для определения нескольких секретов. SecretRef должен ссылаться на секрет, синхронизированный с помощью класса поставщика секретов. Используйте "" для очистки существующих секретов.

--storage-volumes --sv

Ссылка на утверждение постоянного тома в формате key=value, разделенная пробелами. Обязательные ключи: claimName (имя существующего ПВХ), mountPath (путь подключения в контейнере). Пример: claimName=myPVC mountPath=/data. Используйте "" для очистки существующих томов хранилища.

--trust-settings-secret-ref --tssr

Секретная ссылка на сертификаты для доверия. Это указывает имя секрета Kubernetes, содержащего доверенные сертификаты ЦС. Используйте "" для очистки существующих параметров доверия.

Глобальные параметры
--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