az dt route

Note

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

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

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

Команды

Имя Описание Тип Состояние
az dt route create

Добавьте маршрут событий в экземпляр Digital Twins.

Extension GA
az dt route delete

Удалите маршрут событий из экземпляра Digital Twins.

Extension GA
az dt route list

Перечислить настроенные маршруты событий экземпляра Digital Twins.

Extension GA
az dt route show

Отображение сведений о маршруте событий, настроенном в экземпляре Digital Twins.

Extension GA

az dt route create

Добавьте маршрут событий в экземпляр Digital Twins.

az dt route create --dt-name --dtn
                   --en --endpoint-name
                   --rn --route-name
                   [--acquire-policy-token]
                   [--change-reference]
                   [--filter]
                   [--resource-group]

Примеры

Добавляет маршрут событий для существующей конечной точки в целевом экземпляре с фильтром по умолчанию "true".

az dt route create -n {instance_or_hostname} --endpoint-name {endpoint_name} --route-name {route_name}

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

az dt route create -n {instance_or_hostname} --endpoint-name {endpoint_name} --route-name {route_name} --filter "type = 'Microsoft.DigitalTwins.Twin.Create'"

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

--dt-name --dtn -n

Имя экземпляра Digital Twins или имя узла. Если указано имя экземпляра, подписка пользователя сначала запрашивается для целевого экземпляра, чтобы получить имя узла. Если указано имя узла, запрос подписки пропускается, а предоставленное значение используется для последующего взаимодействия.

--en --endpoint-name

Имя конечной точки.

--rn --route-name

Имя маршрута события.

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

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

--acquire-policy-token

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

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

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

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

Фильтр маршрутов событий.

Свойство Значение
Default value: true
--resource-group -g

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью 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 dt route delete

Удалите маршрут событий из экземпляра Digital Twins.

az dt route delete --dt-name --dtn
                   --rn --route-name
                   [--acquire-policy-token]
                   [--change-reference]
                   [--resource-group]

Примеры

Удалите маршрут событий из целевого экземпляра.

az dt route delete -n {instance_or_hostname} --route-name {route_name}

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

--dt-name --dtn -n

Имя экземпляра Digital Twins или имя узла. Если указано имя экземпляра, подписка пользователя сначала запрашивается для целевого экземпляра, чтобы получить имя узла. Если указано имя узла, запрос подписки пропускается, а предоставленное значение используется для последующего взаимодействия.

--rn --route-name

Имя маршрута события.

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

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

--acquire-policy-token

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

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

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

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

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью 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 dt route list

Перечислить настроенные маршруты событий экземпляра Digital Twins.

az dt route list --dt-name --dtn
                 [--resource-group]

Примеры

Список настроенных маршрутов событий целевого экземпляра.

az dt route list -n {instance_or_hostname}

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

--dt-name --dtn -n

Имя экземпляра Digital Twins или имя узла. Если указано имя экземпляра, подписка пользователя сначала запрашивается для целевого экземпляра, чтобы получить имя узла. Если указано имя узла, запрос подписки пропускается, а предоставленное значение используется для последующего взаимодействия.

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

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

--resource-group -g

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью 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 dt route show

Отображение сведений о маршруте событий, настроенном в экземпляре Digital Twins.

az dt route show --dt-name --dtn
                 --rn --route-name
                 [--resource-group]

Примеры

Отображение маршрута событий в целевом экземпляре.

az dt route show -n {instance_or_hostname} --route-name {route_name}

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

--dt-name --dtn -n

Имя экземпляра Digital Twins или имя узла. Если указано имя экземпляра, подписка пользователя сначала запрашивается для целевого экземпляра, чтобы получить имя узла. Если указано имя узла, запрос подписки пропускается, а предоставленное значение используется для последующего взаимодействия.

--rn --route-name

Имя маршрута события.

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

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

--resource-group -g

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью 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