az iot ops broker authn

Note

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

Управление проверкой подлинности брокера Mqtt.

Команды

Имя Описание Тип Состояние
az iot ops broker authn apply

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

 Extension GA
az iot ops broker authn delete

Удалите ресурс проверки подлинности брокера mqtt.

 Extension GA
az iot ops broker authn list

Вывод списка ресурсов проверки подлинности брокера mqtt, связанных с брокером.

 Extension GA
az iot ops broker authn method

Операции метода authn брокера Mqtt.

 Extension GA
az iot ops broker authn method add

Добавьте методы проверки подлинности в ресурс проверки подлинности брокера mqtt.

 Extension GA
az iot ops broker authn show

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

 Extension GA

az iot ops broker authn apply

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

Пример формата файла конфигурации выглядит следующим образом:

{
    "authenticationMethods": [
        {
            "method": "Custom",
            "customSettings": {
                "endpoint": "https://auth-server-template",
                "caCertConfigMap": "custom-auth-ca",
                "auth": {
                    "x509": {
                        "secretRef": "custom-auth-client-cert"
                    }
                },
                "headers": {
                    "header_key": "header_value"
                }
            }
        },
        {
            "method": "ServiceAccountToken",
            "serviceAccountTokenSettings": {
                "audiences": [
                    "aio-internal",
                    "my-audience"
                ]
            }
        },
        {
            "method": "X509",
            "x509Settings": {
                "trustedClientCaCert": "client-ca",
                "authorizationAttributes": {
                    "root": {
                        "attributes": {
                            "organization": "contoso"
                        },
                        "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US"
                    },
                    "intermediate": {
                        "attributes": {
                            "city": "seattle",
                            "foo": "bar"
                        },
                        "subject": "CN = Contoso Intermediate CA"
                    },
                    "smartfan": {
                        "attributes": {
                            "building": "17"
                        },
                        "subject": "CN = smart-fan"
                    }
                }
            }
        }
    ]
}

При использовании с применением приведенного выше содержимого будет создан или заменен целевой ресурс проверки подлинности, настроенный тремя методами authn.

az iot ops broker authn apply --config-file
                              --instance
                              --name
                              --resource-group
                              [--acquire-policy-token]
                              [--broker]
                              [--change-reference]

Примеры

Создайте или замените ресурс проверки подлинности для брокера по умолчанию с помощью файла конфигурации.

az iot ops broker authn apply -n authn --in myinstance -g myresourcegroup --config-file /path/to/authn/config.json

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

--config-file

Путь к файлу конфигурации с свойствами ресурса в формате JSON. Файл конфигурации должен содержать объект со свойствами, совместимыми с представлением ресурса ARM. Объект коррелирует непосредственно с "свойствами:{}" ресурса ARM.

Свойство Значение
Группа параметров: Config Arguments
--instance -i

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

--name -n

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

--resource-group -g

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

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

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

--acquire-policy-token

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

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

Имя брокера Mqtt.

Свойство Значение
Default value: default
--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 ops broker authn delete

Удалите ресурс проверки подлинности брокера mqtt.

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

Примеры

Удалите ресурс проверки подлинности брокера с именем authn, связанный с брокером по умолчанию.

az iot ops broker authn delete -n authn --in myinstance -g myresourcegroup

Аналогично предыдущему примеру, но пропускает запрос на подтверждение.

az iot ops broker authn delete -n authn --in myinstance -g myresourcegroup -y

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

--instance -i

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

--name -n

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

--resource-group -g

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

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

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

--acquire-policy-token

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

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

Имя брокера Mqtt.

Свойство Значение
Default value: default
--change-reference

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

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

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

Свойство Значение
Допустимые значения: 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 broker authn list

Вывод списка ресурсов проверки подлинности брокера mqtt, связанных с брокером.

az iot ops broker authn list --instance
                             --resource-group
                             [--broker]

Примеры

Перечислите все ресурсы проверки подлинности брокера, связанные с брокером по умолчанию.

az iot ops broker authn list --in myinstance -g myresourcegroup

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

--instance -i

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

--resource-group -g

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

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

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

--broker -b

Имя брокера Mqtt.

Свойство Значение
Default value: default
Глобальные параметры
--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 broker authn show

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

az iot ops broker authn show --instance
                             --name
                             --resource-group
                             [--broker]

Примеры

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

az iot ops broker authn show -n authn --in myinstance -g myresourcegroup

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

--instance -i

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

--name -n

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

--resource-group -g

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

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

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

--broker -b

Имя брокера Mqtt.

Свойство Значение
Default value: default
Глобальные параметры
--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