Поделиться через


az eventhubs eventhub

Управление концентратором событий Azure EventHubs и правилом авторизации.

Команды

Имя Описание Тип Состояние
az eventhubs eventhub authorization-rule

Правило авторизации Eventhub.

Ядро ГА
az eventhubs eventhub authorization-rule create

Создайте authorizationRule для указанного концентратора событий. Создание и обновление AuthorizationRule займет несколько секунд.

Ядро ГА
az eventhubs eventhub authorization-rule delete

Удалите авторизацию концентратора событийRule.

Ядро ГА
az eventhubs eventhub authorization-rule keys

Ключи правил авторизации.

Ядро ГА
az eventhubs eventhub authorization-rule keys list

Возвращает строки подключения ACS и SAS для Концентратора событий.

Ядро ГА
az eventhubs eventhub authorization-rule keys renew

Повторно создает строки подключения ACS и SAS для концентратора событий.

Ядро ГА
az eventhubs eventhub authorization-rule list

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

Ядро ГА
az eventhubs eventhub authorization-rule show

Получите AuthorizationRule для концентратора событий по имени правила.

Ядро ГА
az eventhubs eventhub authorization-rule update

Обновите authorizationRule для указанного концентратора событий. Создание и обновление AuthorizationRule займет несколько секунд.

Ядро ГА
az eventhubs eventhub consumer-group

Управление группой потребителей Центров событий Azure.

Ядро ГА
az eventhubs eventhub consumer-group create

Создайте группу потребителей Центров событий в качестве вложенного ресурса в пространстве имен.

Ядро ГА
az eventhubs eventhub consumer-group delete

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

Ядро ГА
az eventhubs eventhub consumer-group list

Список всех групп потребителей в пространстве имен. Пустой веб-канал возвращается, если в пространстве имен нет группы потребителей.

Ядро ГА
az eventhubs eventhub consumer-group show

Получите описание указанной группы потребителей.

Ядро ГА
az eventhubs eventhub consumer-group update

Обновите группу потребителей Центров событий как вложенный ресурс в пространстве имен.

Ядро ГА
az eventhubs eventhub create

Создает EventHubs Eventhub.

Ядро ГА
az eventhubs eventhub delete

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

Ядро ГА
az eventhubs eventhub list

Вывод списка всех центров событий в пространстве имен.

Ядро ГА
az eventhubs eventhub show

Получите описание Центров событий для указанного концентратора событий.

Ядро ГА
az eventhubs eventhub update

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

Ядро ГА

az eventhubs eventhub create

Создает EventHubs Eventhub.

az eventhubs eventhub create --name
                             --namespace-name
                             --resource-group
                             [--archive-name-format]
                             [--blob-container]
                             [--capture-interval]
                             [--capture-size-limit]
                             [--cleanup-policy {Compact, Delete, DeleteOrCompact}]
                             [--destination-name]
                             [--enable-capture {false, true}]
                             [--mi-system-assigned {false, true}]
                             [--mi-user-assigned]
                             [--min-compaction-lag-in-mins]
                             [--partition-count]
                             [--retention-time]
                             [--skip-empty-archives {false, true}]
                             [--status {Active, Disabled, SendDisabled}]
                             [--storage-account]
                             [--timestamp-type {Create, LogAppend}]
                             [--tombstone-retention-time-in-hours]
                             [--user-metadata]

Примеры

Создайте новый концентратор событий.

az eventhubs eventhub create --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub --cleanup-policy Delete --partition-count 15

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

--name -n

Имя eventhub.

--namespace-name

Имя пространства имен.

--resource-group -g

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

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

--archive-name-format

Соглашение об именовании BLOB-объектов для архива, например {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Здесь все параметры (пространство имен, EventHub и т. д.) являются обязательными независимо от порядка.

--blob-container

Имя контейнера BLOB-объектов.

--capture-interval

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

--capture-size-limit

Определяет объем данных, созданных в Концентраторе событий перед операцией записи, значение должно находиться между 10485760 до 524288000 байтов.

--cleanup-policy

Перечисляет возможные значения политики очистки.

Допустимые значения: Compact, Delete, DeleteOrCompact
--destination-name

Имя назначения записи должно быть EventHubArchive.AzureBlockBlob.

--enable-capture

Логическое значение, указывающее, включена ли запись.

Допустимые значения: false, true
--mi-system-assigned

Включите назначенное системой удостоверение.

Допустимые значения: false, true
Default value: False
--mi-user-assigned

Список идентификаторов назначенных пользователем удостоверений.

--min-compaction-lag-in-mins --min-lag

Минимальное время, когда сообщение останется недопустимым для сжатия в журнале. Это значение используется, когда cleanupPolicy имеет значение Compact или DeleteOrCompact.

--partition-count

Количество секций, созданных для концентратора событий. По умолчанию допустимые значения — 2–32. Меньшее значение 1 поддерживается в пространствах имен с поддержкой Kafka. При наличии настраиваемой квоты верхний предел будет соответствовать верхнему пределу квоты.

--retention-time --retention-time-in-hours

Количество часов для сохранения событий для этого концентратора событий. Это значение используется только в том случае, если параметр cleanupPolicy — Delete. Если cleanupPolicy — Compaction возвращаемое значение этого свойства— Long.MaxValue.

--skip-empty-archives

Логическое значение, указывающее, следует ли пропускать пустое.

Допустимые значения: false, true
--status

Состояние eventhub.

Допустимые значения: Active, Disabled, SendDisabled
--storage-account

Имя (если в той же группе ресурсов, а не в классическом хранилище) или идентификатор ARM учетной записи хранения, используемой для создания больших двоичных объектов.

--timestamp-type

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

Допустимые значения: Create, LogAppend
--tombstone-retention-time-in-hours --tombstone-time

Количество часов для хранения маркеров сложенного концентратора событий. Это значение используется только в том случае, если cleanupPolicy — Compaction. Потребитель должен завершить чтение маркера могилы в течение указанного периода времени, если потребитель начинает с начала смещения, чтобы убедиться, что они получают допустимый моментальный снимок для определенного ключа, описанного маркером могилы в сжатом концентраторе событий.

--user-metadata

Возвращает и задает метаданные пользователя.

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

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

--help -h

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

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az eventhubs eventhub delete

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

az eventhubs eventhub delete [--event-hub-name]
                             [--ids]
                             [--namespace-name]
                             [--resource-group]
                             [--subscription]

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

--event-hub-name --name -n

Имя концентратора событий.

--ids

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

--namespace-name

Имя пространства имен.

--resource-group -g

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

--subscription

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

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

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

--help -h

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

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az eventhubs eventhub list

Вывод списка всех центров событий в пространстве имен.

az eventhubs eventhub list --namespace-name
                           --resource-group
                           [--max-items]
                           [--next-token]
                           [--skip]
                           [--top]

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

--namespace-name

Имя пространства имен.

--resource-group -g

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

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

--max-items

Общее количество элементов, возвращаемых в выходных данных команды. Если общее количество доступных элементов превышает указанное значение, маркер предоставляется в выходных данных команды. Чтобы возобновить разбиение на страницы, укажите значение маркера в --next-token аргументе последующей команды.

--next-token

Маркер, чтобы указать, где начать разбиение на страницы. Это значение маркера из ранее усеченного ответа.

--skip

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

--top

Можно использовать для ограничения количества результатов до последних N usageDetails.

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

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

--help -h

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

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az eventhubs eventhub show

Получите описание Центров событий для указанного концентратора событий.

az eventhubs eventhub show [--event-hub-name]
                           [--ids]
                           [--namespace-name]
                           [--resource-group]
                           [--subscription]

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

--event-hub-name --name -n

Имя концентратора событий.

--ids

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

--namespace-name

Имя пространства имен.

--resource-group -g

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

--subscription

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

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

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

--help -h

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

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az eventhubs eventhub update

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

az eventhubs eventhub update [--add]
                             [--archive-name-format]
                             [--blob-container]
                             [--capture-interval]
                             [--capture-size-limit]
                             [--cleanup-policy {Compact, Delete, DeleteOrCompact}]
                             [--destination-name]
                             [--enable-capture {0, 1, f, false, n, no, t, true, y, yes}]
                             [--encoding {Avro, AvroDeflate}]
                             [--event-hub-name]
                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                             [--identity]
                             [--ids]
                             [--min-compaction-lag-in-mins]
                             [--namespace-name]
                             [--partition-count]
                             [--remove]
                             [--resource-group]
                             [--retention-time]
                             [--set]
                             [--skip-empty-archives {0, 1, f, false, n, no, t, true, y, yes}]
                             [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]
                             [--storage-account]
                             [--subscription]
                             [--timestamp-type {Create, LogAppend}]
                             [--tombstone-retention-time-in-hours]
                             [--user-metadata]

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

--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

--archive-name-format

Соглашение об именовании BLOB-объектов для архива, например {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Здесь все параметры (пространство имен, EventHub и т. д.) являются обязательными независимо от порядка.

--blob-container

Имя контейнера BLOB-объектов.

--capture-interval

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

--capture-size-limit

Окно размера определяет объем данных, созданных в Концентраторе событий перед операцией записи, значение должно находиться между 10485760 до 524288000 байтов.

--cleanup-policy

Перечисляет возможные значения политики очистки.

Допустимые значения: Compact, Delete, DeleteOrCompact
--destination-name

Имя назначения записи.

--enable-capture

Значение, указывающее, включено ли описание записи.

Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--encoding

Перечисляет возможные значения для формата кодирования описания записи. Примечание. AvroDeflate не рекомендуется использовать в новой версии API.

Допустимые значения: Avro, AvroDeflate
--event-hub-name --name -n

Имя концентратора событий.

--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--identity

Значение, указывающее, включено ли описание записи. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

--ids

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

--min-compaction-lag-in-mins --min-lag

Минимальное время, когда сообщение останется недопустимым для сжатия в журнале. Это значение используется, когда cleanupPolicy имеет значение Compact или DeleteOrCompact.

--namespace-name

Имя пространства имен.

--partition-count

Число секций, созданных для концентратора событий, допустимые значения — от 1 до 32 секций.

--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--retention-time --retention-time-in-hours

Количество часов для сохранения событий для этого концентратора событий. Это значение используется только в том случае, если параметр cleanupPolicy — Delete. Если cleanupPolicy — Compaction возвращаемое значение этого свойства— Long.MaxValue.

--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

--skip-empty-archives

Значение, указывающее, следует ли пропускать пустые архивы.

Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--status

Перечисляет возможные значения состояния концентратора событий.

Допустимые значения: Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown
--storage-account

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

--subscription

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

--timestamp-type

Обозначает тип метки времени, который будет храниться. Два типа меток времени : "AppendTime" и "CreateTime". AppendTime ссылается на время добавления сообщения в журнал брокера. CreateTime ссылается на время создания сообщения на стороне источника, и производители могут задать эту метку времени при отправке сообщения. Значением по умолчанию является AppendTime. Если вы используете протокол AMQP, CreateTime равно AppendTime и его поведение остается неизменным.

Допустимые значения: Create, LogAppend
--tombstone-retention-time-in-hours -t

Количество часов для хранения маркеров сложенного концентратора событий. Это значение используется только в том случае, если cleanupPolicy — Compaction. Потребитель должен завершить чтение маркера могилы в течение указанного периода времени, если потребитель начинает с начала смещения, чтобы убедиться, что они получают допустимый моментальный снимок для определенного ключа, описанного маркером могилы в сжатом концентраторе событий.

--user-metadata

Возвращает и задает метаданные пользователя.

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

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

--help -h

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

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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