az dt endpoint

Note

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

Управление конечными точками экземпляров Digital Twins и настройка.

Команды

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

Добавьте конечные точки исходящего трафика в экземпляр Digital Twins.

Extension GA
az dt endpoint create eventgrid

Добавляет конечную точку раздела EventGrid в экземпляр Digital Twins. Требуется предварительно созданный ресурс.

Extension GA
az dt endpoint create eventhub

Добавляет конечную точку EventHub в экземпляр Digital Twins.

Extension GA
az dt endpoint create servicebus

Добавляет конечную точку раздела ServiceBus в экземпляр Digital Twins.

Extension GA
az dt endpoint delete

Удалите конечную точку из экземпляра Digital Twins.

Extension GA
az dt endpoint list

Вывод списка всех конечных точек исходящего трафика, настроенных в экземпляре Digital Twins.

Extension GA
az dt endpoint show

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

Extension GA
az dt endpoint wait

Дождитесь завершения операции конечной точки.

Extension GA

az dt endpoint delete

Удалите конечную точку из экземпляра Digital Twins.

az dt endpoint delete --dt-name --dtn
                      --en --endpoint-name
                      [--acquire-policy-token]
                      [--change-reference]
                      [--no-wait]
                      [--resource-group]
                      [--yes]

Примеры

Удалите конечную точку из экземпляра и блокируйте до завершения операции.

az dt endpoint delete -n {instance_name} --endpoint-name {endpoint_name}

Удалите конечную точку из экземпляра без подтверждения или блокировки.

az dt endpoint delete -n {instance_name} --endpoint-name {endpoint_name} -y --no-wait

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

--dt-name --dtn -n

Имя экземпляра Digital Twins.

--en --endpoint-name

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

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

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

--acquire-policy-token

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

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

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

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

Не ожидать завершения длительной операции.

Свойство Значение
Значение по умолчанию: False
--resource-group -g

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью az configure --defaults group={name}.

--yes -y

Не запрашивать подтверждение.

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

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

Свойство Значение
Значение по умолчанию: False
--help -h

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

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Значение по умолчанию: False

az dt endpoint list

Вывод списка всех конечных точек исходящего трафика, настроенных в экземпляре Digital Twins.

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

Примеры

Вывод списка всех конечных точек исходящего трафика, настроенных для экземпляра.

az dt endpoint list -n {instance_name}

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

--dt-name --dtn -n

Имя экземпляра Digital Twins.

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

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

--resource-group -g

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью az configure --defaults group={name}.

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

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

Свойство Значение
Значение по умолчанию: False
--help -h

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

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Значение по умолчанию: False

az dt endpoint show

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

az dt endpoint show --dt-name --dtn
                    --en --endpoint-name
                    [--resource-group]

Примеры

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

az dt endpoint show -n {instance_name} --endpoint-name {endpoint_name}

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

--dt-name --dtn -n

Имя экземпляра Digital Twins.

--en --endpoint-name

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

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

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

--resource-group -g

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью az configure --defaults group={name}.

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

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

Свойство Значение
Значение по умолчанию: False
--help -h

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

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Значение по умолчанию: False

az dt endpoint wait

Дождитесь завершения операции конечной точки.

az dt endpoint wait --dt-name --dtn
                    --en --endpoint-name
                    [--acquire-policy-token]
                    [--change-reference]
                    [--created]
                    [--custom]
                    [--deleted]
                    [--exists]
                    [--interval]
                    [--resource-group]
                    [--timeout]

Примеры

Дождитесь создания конечной точки для экземпляра.

az dt endpoint wait -n {instance_name} --endpoint-name {endpoint_name} --created

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

az dt endpoint wait -n {instance_name} --endpoint-name {endpoint_name} --deleted

Подождите, пока основной соединитель конечной точки имеет значение NULL.

az dt endpoint wait -n {instance_name} --endpoint-name {endpoint_name} --custom "properties.primaryConnectionString==null"

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

--dt-name --dtn -n

Имя экземпляра Digital Twins.

--en --endpoint-name

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

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

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

--acquire-policy-token

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

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

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

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

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

Свойство Значение
Группа параметров: Wait Condition Arguments
Значение по умолчанию: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

Свойство Значение
Группа параметров: Wait Condition Arguments
--deleted

Дождитесь удаления.

Свойство Значение
Группа параметров: Wait Condition Arguments
Значение по умолчанию: False
--exists

Подождите, пока ресурс не существует.

Свойство Значение
Группа параметров: Wait Condition Arguments
Значение по умолчанию: False
--interval

Интервал опроса в секундах.

Свойство Значение
Группа параметров: Wait Condition Arguments
Значение по умолчанию: 30
--resource-group -g

Группа ресурсов экземпляра Digital Twins. Группу по умолчанию можно настроить с помощью az configure --defaults group={name}.

--timeout

Максимальное ожидание в секундах.

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

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

Свойство Значение
Значение по умолчанию: False
--help -h

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

--only-show-errors

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

Свойство Значение
Значение по умолчанию: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Значение по умолчанию: False