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

Event Hubs - List By Namespace

  • Ссылка
Служба:
Event Hubs
Версия API:
2024-01-01

Возвращает все Центры событий в пространстве имен.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs?api-version=2024-01-01
С использованием необязательных параметров: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs?api-version=2024-01-01&$skip={$skip}&$top={$top}

Параметры URI

Имя В Обязательно Тип Описание
namespaceName
 path True

string

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

Шаблон регулярного выражения: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName
 path True

string

Имя группы ресурсов в подписке Azure.
subscriptionId
 path True

string

Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version
 query True

string

Версия API клиента.
$skip
 query

integer

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

integer

Можно использовать, чтобы ограничить количество результатов самыми последними N usageDetails.

Ответы

Имя Тип Описание
200 OK

EventHubListResult

Список Центров событий успешно получен.
Other Status Codes

ErrorResponse

Ответ об ошибке концентратора событий, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

EventHubsListAll

Образец запроса

GET https://management.azure.com/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5357/eventhubs?api-version=2024-01-01

Пример ответа

Код состояния:
200 
{
  "value": [
    {
      "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-716/eventhubs/sdk-eventhub-10",
      "name": "sdk-eventhub-10",
      "type": "Microsoft.EventHub/Namespaces/EventHubs",
      "properties": {
        "messageRetentionInDays": 4,
        "partitionCount": 4,
        "status": "Active",
        "createdAt": "2017-06-28T02:45:55.877Z",
        "updatedAt": "2017-06-28T02:46:05.877Z",
        "partitionIds": [
          "0",
          "1",
          "2",
          "3"
        ],
        "captureDescription": {
          "enabled": true,
          "encoding": "Avro",
          "destination": {
            "name": "EventHubArchive.AzureBlockBlob",
            "properties": {
              "storageAccountResourceId": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage",
              "blobContainer": "container",
              "archiveNameFormat": "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}"
            }
          },
          "intervalInSeconds": 120,
          "sizeLimitInBytes": 10485763
        },
        "retentionDescription": {
          "cleanupPolicy": "Delete",
          "retentionTimeInHours": 96,
          "tombstoneRetentionTimeInHours": 1
        }
      }
    }
  ]
}

Определения

Имя Описание
CaptureDescription

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

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

Тип управляемого удостоверения Azure Active Directory.
CleanupPolicyRetentionDescription

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

Тип удостоверения, создавшего ресурс.
Destination

Запись сведений о хранилище для описания записи
EncodingCaptureDescription

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

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

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

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

Один элемент в операции List или Get Event Hub
EventHubListResult

Результат операции List EventHubs.
RetentionDescription

Свойства для настройки параметров хранения для концентратора событий
systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

CaptureDescription

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

Имя Тип Описание
destination

Destination

Свойства назначения, в котором будет храниться запись. (учетная запись хранения, имена BLOB-объектов)
enabled

boolean

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

EncodingCaptureDescription

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

integer

Временное окно позволяет задать частоту записи в BLOB-объекты Azure. Значение должно составлять от 60 до 900 секунд.
sizeLimitInBytes

integer

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

boolean

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

CaptureIdentity

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

Имя Тип Описание
type

CaptureIdentityType

Тип управляемого удостоверения Azure Active Directory.
userAssignedIdentity

string

Идентификатор ARM управляемого удостоверения пользователя. Это свойство является обязательным, если тип — UserAssignedIdentity. Если тип — SystemAssigned, будет использоваться назначенное системой удостоверение, связанное с пространством имен.

CaptureIdentityType

Тип управляемого удостоверения Azure Active Directory.

Имя Тип Описание
SystemAssigned

string

UserAssigned

string

CleanupPolicyRetentionDescription

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

Имя Тип Описание
Compact

string

Delete

string

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

Destination

Запись сведений о хранилище для описания записи

Имя Тип Описание
identity

CaptureIdentity

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

string

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

string

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

string

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

string

Имя Azure Data Lake Store для захваченных событий
properties.dataLakeFolderPath

string

Путь к конечной папке для захваченных событий
properties.dataLakeSubscriptionId

string

Идентификатор подписки Azure Data Lake Store
properties.storageAccountResourceId

string

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

EncodingCaptureDescription

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

Имя Тип Описание
Avro

string

AvroDeflate

string

EntityStatus

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

Имя Тип Описание
Active

string

Creating

string

Deleting

string

Disabled

string

ReceiveDisabled

string

Renaming

string

Restoring

string

SendDisabled

string

Unknown

string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

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

Имя Тип Описание
error

ErrorDetail

Объект error.

Eventhub

Один элемент в операции List или Get Event Hub

Имя Тип Описание
id

string

Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

Географическое расположение, в котором находится ресурс
name

string

Имя ресурса.
properties.captureDescription

CaptureDescription

Свойства описания записи
properties.createdAt

string

Точное время создания концентратора событий.
properties.messageRetentionInDays

integer

Количество дней для хранения событий для этого концентратора событий, значение должно быть от 1 до 7 дней
properties.partitionCount

integer

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

string[]

Текущее количество сегментов в концентраторе событий.
properties.retentionDescription

RetentionDescription

Параметры хранения концентратора событий
properties.status

EntityStatus

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

string

Точное время обновления сообщения.
properties.userMetadata

string

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

systemData

Системные метаданные, относящиеся к этому ресурсу.
type

string

Тип ресурса. Например, "Microsoft.EventHub/Namespaces" или "Microsoft.EventHub/Namespaces/EventHubs"

EventHubListResult

Результат операции List EventHubs.

Имя Тип Описание
nextLink

string

Ссылка на следующий набор результатов. Не пуст, если значение содержит неполный список концентраторов событий.
value

Eventhub[]

Результат операции List EventHubs.

RetentionDescription

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

Имя Тип Описание
cleanupPolicy

CleanupPolicyRetentionDescription

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

integer

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

integer

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

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

Тип удостоверения, создавшего ресурс.
lastModifiedAt

string

Тип удостоверения, которое последним изменял ресурс.
lastModifiedBy

string

Удостоверение, которое последним изменял ресурс.
lastModifiedByType

createdByType

Тип удостоверения, которое последним изменял ресурс.