az iot hub message-endpoint update

  • Предварительный просмотр

Note

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

Группа команд "iot hub message-endpoint" находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Обновите свойства существующей конечной точки для IoT Hub.

Команды

Имя Описание Тип Состояние
az iot hub message-endpoint update cosmosdb-container

Обновите свойства существующей конечной точки контейнера Cosmos DB для IoT Hub.

 Extension Preview
az iot hub message-endpoint update eventhub

Обновите свойства существующей конечной точки Концентратора событий для IoT Hub.

 Extension Preview
az iot hub message-endpoint update servicebus-queue

Обновите свойства существующей конечной точки очереди Service Bus для IoT Hub.

 Extension Preview
az iot hub message-endpoint update servicebus-topic

Обновите свойства существующей конечной точки раздела Service Bus для IoT Hub.

 Extension Preview
az iot hub message-endpoint update storage-container

Обновите свойства существующей конечной точки контейнера хранилища для IoT Hub.

 Extension Preview

az iot hub message-endpoint update cosmosdb-container

Предварительный просмотр

Группа команд "iot hub message-endpoint" находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Обновите свойства существующей конечной точки контейнера Cosmos DB для IoT Hub.

При обновлении типа проверки подлинности на основе ключа до конечной точки контейнера Cosmos DB на основе удостоверений необходимо указать удостоверение (через --identity) и uri конечной точки (через --endpoint-uri). Старый первичный ключ и вторичный ключ будут отключены.

При обновлении типа проверки подлинности с удостоверений до конечной точки контейнера Cosmos DB на основе ключей необходимо указать connection string (через --connection-string), первичный ключ (через --primary-key) или дополнительный ключ (через ---secondary-key).

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

az iot hub message-endpoint update cosmosdb-container --en --endpoint --endpoint-name
                                                      [--acquire-policy-token]
                                                      [--change-reference]
                                                      [--connection-string]
                                                      [--database-name --db]
                                                      [--endpoint-resource-group --erg]
                                                      [--endpoint-subscription-id]
                                                      [--endpoint-uri]
                                                      [--hub-name]
                                                      [--identity]
                                                      [--ids]
                                                      [--partition-key-name --pkn]
                                                      [--partition-key-template --pkt]
                                                      [--pk --primary-key]
                                                      [--resource-group]
                                                      [--secondary-key --sk]
                                                      [--subscription]

Примеры

Обновите конечную точку контейнера Cosmos DB на основе ключей или на основе удостоверений, чтобы IoT Hub использовать новый указанный connection string.

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --connection-string {connection_string}

Обновите конечную точку контейнера Cosmos DB для IoT Hub, чтобы использовать указанный первичный ключ и вторичный ключ.

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pk {primary_key} --sk {secondary_key}

Обновите конечную точку контейнера Cosmos DB для IoT Hub, чтобы использовать назначенное системой удостоверение и имя ключа секции. Шаблон ключа секции будет по умолчанию.

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --pkn {partition_key_name} --identity [system]

Обновите конечную точку контейнера Cosmos DB на основе ключа для IoT Hub, чтобы использовать назначенное пользователем удостоверение (можно пропустить URI --endpoint-URI, если конечная точка уже основана на удостоверениях).

az iot hub message-endpoint update cosmosdb-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}

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

--en --endpoint --endpoint-name

Имя конечной точки маршрутизации.

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

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

--acquire-policy-token

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

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

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

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

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

--database-name --db

Имя базы данных Cosmos DB в учетной записи Cosmos DB.

--endpoint-resource-group --erg -r

Группа ресурсов ресурса ресурса конечной точки. Если это не указано, будет использоваться группа ресурсов IoT Hub.

--endpoint-subscription-id -s

Идентификатор подписки ресурса конечной точки. Если это не указано, будет использоваться подписка IoT Hub.

--endpoint-uri

URI ресурса конечной точки.

--hub-name -n

IoT Hub имя.

Свойство Значение
Группа параметров: Resource Id Arguments
--identity

Используйте управляемое удостоверение, назначаемое системой или назначаемое пользователем, для проверки подлинности конечной точки. Используйте [system], чтобы ссылаться на удостоверение, назначаемое системой, или идентификатор ресурса, чтобы ссылаться на удостоверение, назначаемое пользователем.

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Группа параметров: Resource Id Arguments
--partition-key-name --pkn

Имя ключа секции, связанного с этим контейнером SQL Cosmos DB, если он существует. Чтобы очистить это свойство, задайте значение "".

--partition-key-template --pkt

Шаблон для создания значения искусственного ключа секции для использования с этим контейнером SQL Cosmos DB. Шаблон должен содержать по крайней мере один из следующих заполнителей: {iothub}, {deviceid}, {DD}, {MM}и {ГГГГ}. Любой заполнитель может быть указан по крайней мере один раз, но порядок и компоненты, не являющиеся заполнителями, являются произвольными. Если указано имя ключа секции, шаблон ключа секции по умолчанию имеет значение {deviceid}-{ГГГГ}-{MM}. Чтобы очистить это свойство, задайте значение "".

--pk --primary-key

Первичный ключ учетной записи Cosmos DB.

--resource-group -g

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

Свойство Значение
Группа параметров: Resource Id Arguments
--secondary-key --sk

Вторичный ключ учетной записи Cosmos DB.

--subscription

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

Свойство Значение
Группа параметров: Resource Id 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/.

--verbose

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

Свойство Значение
Default value: False

az iot hub message-endpoint update eventhub

Предварительный просмотр

Группа команд "iot hub message-endpoint" находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Обновите свойства существующей конечной точки Концентратора событий для IoT Hub.

При обновлении типа проверки подлинности с ключа до конечной точки концентратора событий на основе удостоверений необходимо указать удостоверение (через --identity), uri конечной точки (через --endpoint-uri) и путь сущности (через --entity-path). Старый connection string будет иметь значение NULL.

При обновлении типа проверки подлинности с удостоверений до конечной точки концентратора событий на основе ключей необходимо указать connection string (через строку --connection-string). Старый uri конечной точки и путь сущности будет отключен.

az iot hub message-endpoint update eventhub --en --endpoint --endpoint-name
                                            [--acquire-policy-token]
                                            [--change-reference]
                                            [--connection-string]
                                            [--endpoint-resource-group --erg]
                                            [--endpoint-subscription-id]
                                            [--endpoint-uri]
                                            [--entity-path]
                                            [--hub-name]
                                            [--identity]
                                            [--ids]
                                            [--resource-group]
                                            [--subscription]

Примеры

Обновите конечную точку концентратора событий на основе ключей или на основе удостоверений, чтобы IoT Hub использовать новый указанный connection string.

az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} -c {connection_string}

Обновите конечную точку Концентратора событий для IoT Hub, чтобы использовать назначенное системой удостоверение и другой путь сущности.

az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]

Обновите конечную точку концентратора событий на основе ключей для IoT Hub, чтобы использовать назначенное пользователем удостоверение (можно пропустить URI --endpoint-URI, если конечная точка уже основана на удостоверениях).

az iot hub message-endpoint update eventhub -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}

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

--en --endpoint --endpoint-name

Имя конечной точки маршрутизации.

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

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

--acquire-policy-token

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

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

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

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

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

--endpoint-resource-group --erg -r

Группа ресурсов ресурса ресурса конечной точки. Если это не указано, будет использоваться группа ресурсов IoT Hub.

--endpoint-subscription-id -s

Идентификатор подписки ресурса конечной точки. Если это не указано, будет использоваться подписка IoT Hub.

--endpoint-uri

URI ресурса конечной точки.

--entity-path

Путь сущности ресурса конечной точки.

--hub-name -n

IoT Hub имя.

Свойство Значение
Группа параметров: Resource Id Arguments
--identity

Используйте управляемое удостоверение, назначаемое системой или назначаемое пользователем, для проверки подлинности конечной точки. Используйте [system], чтобы ссылаться на удостоверение, назначаемое системой, или идентификатор ресурса, чтобы ссылаться на удостоверение, назначаемое пользователем.

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

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

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

Свойство Значение
Группа параметров: Resource Id Arguments
--subscription

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

Свойство Значение
Группа параметров: Resource Id 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/.

--verbose

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

Свойство Значение
Default value: False

az iot hub message-endpoint update servicebus-queue

Предварительный просмотр

Группа команд "iot hub message-endpoint" находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Обновите свойства существующей конечной точки очереди Service Bus для IoT Hub.

При обновлении типа проверки подлинности из ключа на конечную точку очереди на основе ключей Service Bus на основе удостоверений необходимо указать удостоверение (через --identity), uri конечной точки (через --endpoint-uri) и путь сущности (через --entity-path). Старый connection string будет иметь значение NULL.

При обновлении типа проверки подлинности с удостоверений до конечной точки очереди Service Bus на основе ключей необходимо указать connection string (через строку --connection-string). Старый uri конечной точки и путь сущности будет отключен.

az iot hub message-endpoint update servicebus-queue --en --endpoint --endpoint-name
                                                    [--acquire-policy-token]
                                                    [--change-reference]
                                                    [--connection-string]
                                                    [--endpoint-resource-group --erg]
                                                    [--endpoint-subscription-id]
                                                    [--endpoint-uri]
                                                    [--entity-path]
                                                    [--hub-name]
                                                    [--identity]
                                                    [--ids]
                                                    [--resource-group]
                                                    [--subscription]

Примеры

Обновите конечную точку очереди Service Bus на основе ключей или на основе удостоверений, чтобы IoT Hub использовал новый указанный connection string.

az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} -c {connection_string}

Обновите конечную точку очереди Service Bus для IoT Hub, чтобы использовать назначенное системой удостоверение и другой путь сущности.

az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]

Обновите конечную точку очереди Service Bus на основе ключа для IoT Hub, чтобы использовать назначенное пользователем удостоверение (можно пропустить URI --endpoint-URI, если конечная точка уже основана на удостоверениях).

az iot hub message-endpoint update servicebus-queue -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}

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

--en --endpoint --endpoint-name

Имя конечной точки маршрутизации.

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

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

--acquire-policy-token

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

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

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

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

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

--endpoint-resource-group --erg -r

Группа ресурсов ресурса ресурса конечной точки. Если это не указано, будет использоваться группа ресурсов IoT Hub.

--endpoint-subscription-id -s

Идентификатор подписки ресурса конечной точки. Если это не указано, будет использоваться подписка IoT Hub.

--endpoint-uri

URI ресурса конечной точки.

--entity-path

Путь сущности ресурса конечной точки.

--hub-name -n

IoT Hub имя.

Свойство Значение
Группа параметров: Resource Id Arguments
--identity

Используйте управляемое удостоверение, назначаемое системой или назначаемое пользователем, для проверки подлинности конечной точки. Используйте [system], чтобы ссылаться на удостоверение, назначаемое системой, или идентификатор ресурса, чтобы ссылаться на удостоверение, назначаемое пользователем.

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

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

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

Свойство Значение
Группа параметров: Resource Id Arguments
--subscription

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

Свойство Значение
Группа параметров: Resource Id 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/.

--verbose

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

Свойство Значение
Default value: False

az iot hub message-endpoint update servicebus-topic

Предварительный просмотр

Группа команд "iot hub message-endpoint" находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Обновите свойства существующей конечной точки раздела Service Bus для IoT Hub.

При обновлении типа проверки подлинности из ключа на конечную точку Service Bus раздела на основе ключей необходимо указать удостоверение (через --identity), uri конечной точки (через --endpoint-uri) и путь сущности (через --entity-path). Старый connection string будет иметь значение NULL.

При обновлении типа проверки подлинности с удостоверений на конечную точку Service Bus раздела на основе ключей необходимо указать connection string (через строку --connection-string). Старый uri конечной точки и путь сущности будет отключен.

az iot hub message-endpoint update servicebus-topic --en --endpoint --endpoint-name
                                                    [--acquire-policy-token]
                                                    [--change-reference]
                                                    [--connection-string]
                                                    [--endpoint-resource-group --erg]
                                                    [--endpoint-subscription-id]
                                                    [--endpoint-uri]
                                                    [--entity-path]
                                                    [--hub-name]
                                                    [--identity]
                                                    [--ids]
                                                    [--resource-group]
                                                    [--subscription]

Примеры

Обновите конечную точку раздела Service Bus на основе ключей или на основе удостоверений, чтобы IoT Hub использовал новый указанный connection string.

az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} -c {connection_string}

Обновите конечную точку раздела Service Bus для IoT Hub, чтобы использовать назначенное системой удостоверение и другой путь сущности.

az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name} --entity-path {entity_path} --identity [system]

Обновите конечную точку раздела на основе ключа для Service Bus IoT Hub, чтобы использовать назначенное пользователем удостоверение (можно пропустить URI --endpoint-URI, если конечная точка уже основана на удостоверениях).

az iot hub message-endpoint update servicebus-topic -n {iothub_name} --en {endpoint_name}  --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri} --entity-path {entity_path}

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

--en --endpoint --endpoint-name

Имя конечной точки маршрутизации.

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

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

--acquire-policy-token

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

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

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

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

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

--endpoint-resource-group --erg -r

Группа ресурсов ресурса ресурса конечной точки. Если это не указано, будет использоваться группа ресурсов IoT Hub.

--endpoint-subscription-id -s

Идентификатор подписки ресурса конечной точки. Если это не указано, будет использоваться подписка IoT Hub.

--endpoint-uri

URI ресурса конечной точки.

--entity-path

Путь сущности ресурса конечной точки.

--hub-name -n

IoT Hub имя.

Свойство Значение
Группа параметров: Resource Id Arguments
--identity

Используйте управляемое удостоверение, назначаемое системой или назначаемое пользователем, для проверки подлинности конечной точки. Используйте [system], чтобы ссылаться на удостоверение, назначаемое системой, или идентификатор ресурса, чтобы ссылаться на удостоверение, назначаемое пользователем.

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

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

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

Свойство Значение
Группа параметров: Resource Id Arguments
--subscription

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

Свойство Значение
Группа параметров: Resource Id 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/.

--verbose

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

Свойство Значение
Default value: False

az iot hub message-endpoint update storage-container

Предварительный просмотр

Группа команд "iot hub message-endpoint" находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Обновите свойства существующей конечной точки контейнера хранилища для IoT Hub.

При обновлении типа проверки подлинности с помощью ключа до конечной точки контейнера хранилища на основе удостоверений необходимо указать удостоверение (через --identity) и URI конечной точки (через --endpoint-uri). Старый connection string будет иметь значение NULL.

При обновлении типа проверки подлинности с удостоверений до конечной точки контейнера хранилища на основе ключей необходимо указать connection string (через строку --connection-string).

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

az iot hub message-endpoint update storage-container --en --endpoint --endpoint-name
                                                     [--acquire-policy-token]
                                                     [--batch-frequency]
                                                     [--change-reference]
                                                     [--chunk-size]
                                                     [--connection-string]
                                                     [--endpoint-resource-group --erg]
                                                     [--endpoint-subscription-id]
                                                     [--endpoint-uri]
                                                     [--ff --file-name-format]
                                                     [--hub-name]
                                                     [--identity]
                                                     [--ids]
                                                     [--resource-group]
                                                     [--subscription]

Примеры

Обновите конечную точку контейнера хранилища на основе ключей или на основе удостоверений для IoT Hub, чтобы использовать новый указанный connection string.

az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} -c {connection_string}

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

az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name}  -b {batch_frequency} -w {chunk_size} --ff {file_format} --identity [system]

Обновите конечную точку контейнера хранилища на основе ключей для IoT Hub, чтобы использовать назначенное пользователем удостоверение (можно пропустить URI --endpoint-URI, если конечная точка уже основана на удостоверениях).

az iot hub message-endpoint update storage-container -n {iothub_name} --en {endpoint_name} --identity {user_identity_resource_id} --endpoint-uri {endpoint_uri}

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

--en --endpoint --endpoint-name

Имя конечной точки маршрутизации.

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

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

--acquire-policy-token

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

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

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

--change-reference

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

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

Размер блока запроса в мегабайтах (МБ). Максимальный размер больших двоичных объектов в диапазоне от 10 до 500 МБ.

--connection-string -c

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

--endpoint-resource-group --erg -r

Группа ресурсов ресурса ресурса конечной точки. Если это не указано, будет использоваться группа ресурсов IoT Hub.

--endpoint-subscription-id -s

Идентификатор подписки ресурса конечной точки. Если это не указано, будет использоваться подписка IoT Hub.

--endpoint-uri

URI ресурса конечной точки.

--ff --file-name-format

Формат имени файла для большого двоичного объекта. Формат имени файла должен содержать поля {iothub}, {partition}, {YYYY}, {MM}, {DD}, {HH} и {mm}. Все параметры являются обязательными, но могут быть переупорядочены с разделителями или без них.

--hub-name -n

IoT Hub имя.

Свойство Значение
Группа параметров: Resource Id Arguments
--identity

Используйте управляемое удостоверение, назначаемое системой или назначаемое пользователем, для проверки подлинности конечной точки. Используйте [system], чтобы ссылаться на удостоверение, назначаемое системой, или идентификатор ресурса, чтобы ссылаться на удостоверение, назначаемое пользователем.

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

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

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

Свойство Значение
Группа параметров: Resource Id Arguments
--subscription

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

Свойство Значение
Группа параметров: Resource Id 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/.

--verbose

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

Свойство Значение
Default value: False