az iot central api-token

Note

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

Управление маркерами API для приложения IoT Central.

IoT Central позволяет создавать маркеры API и управлять ими для доступа к API IoT Central. Дополнительные сведения об API можно найти по адресу https://aka.ms/iotcentraldocsapi.

Команды

Имя Описание Тип Состояние
az iot central api-token create

Создайте маркер API, связанный с приложением IoT Central.

 Extension GA
az iot central api-token delete

Удалите маркер API, связанный с приложением IoT Central.

 Extension GA
az iot central api-token list

Получите список маркеров API, связанных с приложением IoT Central.

 Extension GA
az iot central api-token show

Получение сведений о маркере API, связанном с приложением IoT Central.

 Extension GA

az iot central api-token create

Создайте маркер API, связанный с приложением IoT Central.

Примечание. Запишите маркер после его создания, так как вы не сможете получить его еще раз.

az iot central api-token create --app-id
                                --role
                                --tkid --token-id
                                [--acquire-policy-token]
                                [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri --central-dns-suffix]
                                [--change-reference]
                                [--org-id --organization-id]
                                [--token]

Примеры

Добавление нового маркера API

az iot central api-token create --token-id {tokenId} --app-id {appId} --role admin

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--role -r

Роль, которая будет связана с этим токеном или пользователем. Можно указать одну из встроенных ролей или указать идентификатор роли пользовательской роли. Дополнительные возможности см. в https://aka.ms/iotcentral-customrolesdocs.

--tkid --token-id

Идентификатор IoT Central, связанный с этим маркером, разрешено [0-9a-zA-Z-], максимальное ограничение длины до 40. Укажите идентификатор, который затем будет использоваться при изменении или удалении этого маркера позже с помощью интерфейса командной строки или API.

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

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

--acquire-policy-token

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

Свойство Значение
Группа параметров: Global Policy Arguments
--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

Свойство Значение
Default value: 2022-07-31
Допустимые значения: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

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

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

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

Идентификатор организации для назначения роли маркера. Доступно только для api-version == 1.1-preview.

--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

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

Удалите маркер API, связанный с приложением IoT Central.

az iot central api-token delete --app-id
                                --tkid --token-id
                                [--acquire-policy-token]
                                [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri --central-dns-suffix]
                                [--change-reference]
                                [--token]

Примеры

Удаление маркера API

az iot central api-token delete --app-id {appid} --token-id {tokenId}

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--tkid --token-id

Идентификатор IoT Central, связанный с этим маркером, разрешено [0-9a-zA-Z-], максимальное ограничение длины до 40. Укажите идентификатор, который затем будет использоваться при изменении или удалении этого маркера позже с помощью интерфейса командной строки или API.

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

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

--acquire-policy-token

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

Свойство Значение
Группа параметров: Global Policy Arguments
--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

Свойство Значение
Default value: 2022-07-31
Допустимые значения: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

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

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

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

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

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

Получите список маркеров API, связанных с приложением IoT Central.

Сведения в списке содержат основные сведения о маркерах в приложении и не включают значения маркеров.

az iot central api-token list --app-id
                              [--api-version --av {2022-06-30-preview, 2022-07-31}]
                              [--central-api-uri --central-dns-suffix]
                              [--token]

Примеры

Список маркеров API

az iot central api-token list --app-id {appid}

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

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

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

--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

Свойство Значение
Default value: 2022-07-31
Допустимые значения: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

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

Получение сведений о маркере API, связанном с приложением IoT Central.

Список сведений, таких как связанная роль, для маркера API в приложении IoT Central.

az iot central api-token show --app-id
                              --tkid --token-id
                              [--api-version --av {2022-06-30-preview, 2022-07-31}]
                              [--central-api-uri --central-dns-suffix]
                              [--token]

Примеры

Получение маркера API

az iot central api-token show --app-id {appid} --token-id {tokenId}

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--tkid --token-id

Идентификатор IoT Central, связанный с этим маркером, разрешено [0-9a-zA-Z-], максимальное ограничение длины до 40. Укажите идентификатор, который затем будет использоваться при изменении или удалении этого маркера позже с помощью интерфейса командной строки или API.

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

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

--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

Свойство Значение
Default value: 2022-07-31
Допустимые значения: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

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