az eventhubs eventhub consumer-group
Управление группой потребителей Центров событий Azure.
Команды
Имя | Описание | Тип | Состояние |
---|---|---|---|
az eventhubs eventhub consumer-group create |
Создайте группу потребителей Центров событий в качестве вложенного ресурса в пространстве имен. |
Core | GA |
az eventhubs eventhub consumer-group delete |
Удалите группу потребителей из указанного концентратора событий и группы ресурсов. |
Core | GA |
az eventhubs eventhub consumer-group list |
Список всех групп потребителей в пространстве имен. Пустой веб-канал возвращается, если в пространстве имен нет группы потребителей. |
Core | GA |
az eventhubs eventhub consumer-group show |
Получите описание указанной группы потребителей. |
Core | GA |
az eventhubs eventhub consumer-group update |
Обновите группу потребителей Центров событий как вложенный ресурс в пространстве имен. |
Core | GA |
az eventhubs eventhub consumer-group create
Создайте группу потребителей Центров событий в качестве вложенного ресурса в пространстве имен.
az eventhubs eventhub consumer-group create --consumer-group-name --name
--eventhub-name
--namespace-name
--resource-group
[--user-metadata]
Обязательные параметры
Имя группы потребителей.
Имя концентратора событий.
Имя пространства имен.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Метаданные пользователя — это заполнитель для хранения пользовательских строковых данных с максимальной длиной 1024. Например, его можно использовать для хранения описательных данных, таких как список команд и контактные данные, а также пользовательские параметры конфигурации.
Свойство | Значение |
---|---|
Parameter group: | Properties Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Свойство | Значение |
---|---|
Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Свойство | Значение |
---|---|
Default value: | False |
Output format.
Свойство | Значение |
---|---|
Default value: | json |
Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
Свойство | Значение |
---|---|
Default value: | False |
az eventhubs eventhub consumer-group delete
Удалите группу потребителей из указанного концентратора событий и группы ресурсов.
az eventhubs eventhub consumer-group delete [--consumer-group-name --name]
[--eventhub-name]
[--ids]
[--namespace-name]
[--resource-group]
[--subscription]
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Имя группы потребителей.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Имя концентратора событий.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Имя пространства имен.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Свойство | Значение |
---|---|
Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Свойство | Значение |
---|---|
Default value: | False |
Output format.
Свойство | Значение |
---|---|
Default value: | json |
Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
Свойство | Значение |
---|---|
Default value: | False |
az eventhubs eventhub consumer-group list
Список всех групп потребителей в пространстве имен. Пустой веб-канал возвращается, если в пространстве имен нет группы потребителей.
az eventhubs eventhub consumer-group list --eventhub-name
--namespace-name
--resource-group
[--max-items]
[--next-token]
[--skip]
[--top]
Обязательные параметры
Имя концентратора событий.
Имя пространства имен.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Общее количество элементов, возвращаемых в выходных данных команды. Если общее количество доступных элементов превышает указанное значение, маркер предоставляется в выходных данных команды. Чтобы возобновить разбиение на страницы, укажите значение маркера в --next-token
аргументе последующей команды.
Свойство | Значение |
---|---|
Parameter group: | Pagination Arguments |
Маркер, чтобы указать, где начать разбиение на страницы. Это значение маркера из ранее усеченного ответа.
Свойство | Значение |
---|---|
Parameter group: | Pagination Arguments |
Пропуск используется только в том случае, если предыдущая операция вернула частичный результат. Если предыдущий ответ содержит элемент nextLink, значение элемента nextLink будет включать параметр пропуска, указывающий начальную точку для последующих вызовов.
Можно использовать для ограничения количества результатов до последних N usageDetails.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Свойство | Значение |
---|---|
Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Свойство | Значение |
---|---|
Default value: | False |
Output format.
Свойство | Значение |
---|---|
Default value: | json |
Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
Свойство | Значение |
---|---|
Default value: | False |
az eventhubs eventhub consumer-group show
Получите описание указанной группы потребителей.
az eventhubs eventhub consumer-group show [--consumer-group-name --name]
[--eventhub-name]
[--ids]
[--namespace-name]
[--resource-group]
[--subscription]
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Имя группы потребителей.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Имя концентратора событий.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Имя пространства имен.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Свойство | Значение |
---|---|
Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Свойство | Значение |
---|---|
Default value: | False |
Output format.
Свойство | Значение |
---|---|
Default value: | json |
Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
Свойство | Значение |
---|---|
Default value: | False |
az eventhubs eventhub consumer-group update
Обновите группу потребителей Центров событий как вложенный ресурс в пространстве имен.
az eventhubs eventhub consumer-group update [--add]
[--consumer-group-name --name]
[--eventhub-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--namespace-name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--user-metadata]
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>
.
Свойство | Значение |
---|---|
Parameter group: | Generic Update Arguments |
Имя группы потребителей.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Имя концентратора событий.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.
Свойство | Значение |
---|---|
Parameter group: | Generic Update Arguments |
Допустимые значения: | 0, 1, f, false, n, no, t, true, y, yes |
Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Имя пространства имен.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Свойство | Значение |
---|---|
Parameter group: | Generic Update Arguments |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>
.
Свойство | Значение |
---|---|
Parameter group: | Generic Update Arguments |
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Свойство | Значение |
---|---|
Parameter group: | Resource Id Arguments |
Метаданные пользователя — это заполнитель для хранения пользовательских строковых данных с максимальной длиной 1024. Например, его можно использовать для хранения описательных данных, таких как список команд и контактные данные, а также пользовательские параметры конфигурации.
Свойство | Значение |
---|---|
Parameter group: | Properties Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Свойство | Значение |
---|---|
Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Свойство | Значение |
---|---|
Default value: | False |
Output format.
Свойство | Значение |
---|---|
Default value: | json |
Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
Свойство | Значение |
---|---|
Default value: | False |