Namespaces - Get
Возвращает описание указанного пространства имен.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}?api-version=2024-01-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
namespace
|
path | True |
string |
Имя пространства имен Шаблон регулярного выражения: |
resource
|
path | True |
string |
Имя группы ресурсов в подписке Azure. |
subscription
|
path | True |
string |
Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы. |
api-version
|
query | True |
string |
Версия API клиента. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Пространство имен успешно возвращено. |
|
Other Status Codes |
Ответ об ошибке концентратора событий, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
NameSpaceGet
Образец запроса
Пример ответа
{
"sku": {
"name": "Standard",
"tier": "Standard",
"capacity": 1
},
"id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample",
"name": "NamespaceSample",
"type": "Microsoft.EventHub/Namespaces",
"location": "East US",
"tags": {},
"identity": {
"principalId": "PrincipalIdGUID",
"tenantId": "TenantIdGUID",
"type": "SystemAssigned, UserAssigned",
"userAssignedIdentities": {
"/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": {
"clientId": "ClientIdGUID",
"principalId": "PrincipalIdGUID"
},
"/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": {
"clientId": "6a35400f-6ccb-4817-8f1a-ce19ea4523bc",
"principalId": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5"
}
}
},
"properties": {
"isAutoInflateEnabled": false,
"disableLocalAuth": false,
"maximumThroughputUnits": 0,
"zoneRedundant": false,
"minimumTlsVersion": "1.2",
"encryption": {
"keySource": "Microsoft.KeyVault",
"keyVaultProperties": [
{
"keyName": "Samplekey",
"keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net",
"keyVersion": "",
"identity": {
"userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1"
}
}
],
"requireInfrastructureEncryption": false
},
"privateEndpointConnections": [
{
"id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample/privateEndpointConnections/privateEndpointConnectionName",
"name": "privateEndpointConnectionName",
"type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.Network/privateEndpoints/NamespaceSample"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Auto-Approved"
}
}
}
],
"provisioningState": "Succeeded",
"clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test",
"metricId": "MetricGUID:NamespaceSample",
"createdAt": "2021-01-30T00:28:38.963Z",
"updatedAt": "2021-01-30T00:30:55.143Z",
"serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443"
}
}
Определения
Имя | Описание |
---|---|
Connection |
Сведения о состоянии подключения. |
created |
Тип удостоверения, создавшего ресурс. |
EHNamespace |
Один элемент пространства имен в списке или операции получения |
End |
Состояние подготовки подключения к частной конечной точке. |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Ответ об ошибке указывает, что служба концентратора событий не может обработать входящий запрос. Причина указана в сообщении об ошибке. |
key |
Перечисляет возможное значение keySource для шифрования. |
Key |
Свойства хранилища ключей |
Managed |
Тип удостоверения управляемой службы. |
Private |
Ресурс частной конечной точки для этого подключения. |
Private |
Список подключений к частной конечной точке. |
Private |
Состояние подключения. |
Public |
Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. |
Sku |
Свойства ресурса SKU |
Sku |
Имя этого номера SKU. |
Sku |
Уровень выставления счетов конкретного номера SKU. |
system |
Метаданные, относящиеся к созданию и последнему изменению ресурса. |
Tls |
Минимальная версия TLS для поддержки кластера, например 1.2. |
User |
Распознанное значение словаря. |
ConnectionState
Сведения о состоянии подключения.
Имя | Тип | Описание |
---|---|---|
description |
string |
Описание состояния подключения. |
status |
Состояние подключения. |
createdByType
Тип удостоверения, создавшего ресурс.
Имя | Тип | Описание |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
EHNamespace
Один элемент пространства имен в списке или операции получения
Имя | Тип | Default value | Описание |
---|---|---|---|
id |
string |
Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity.principalId |
string |
ObjectId из Хранилища ключей |
|
identity.tenantId |
string |
TenantId из Хранилища ключей |
|
identity.type |
Тип удостоверения управляемой службы. |
||
identity.userAssignedIdentities |
<string,
User |
Свойства удостоверений, назначаемых пользователем |
|
location |
string |
Расположение ресурса. |
|
name |
string |
Имя ресурса. |
|
properties.alternateName |
string |
Альтернативное имя указывается, если имена псевдонимов и пространств имен совпадают. |
|
properties.clusterArmId |
string |
Идентификатор ARM кластера пространства имен. |
|
properties.createdAt |
string |
Время создания пространства имен. |
|
properties.disableLocalAuth |
boolean |
Это свойство отключает проверку подлинности SAS для пространства имен Центров событий. |
|
properties.encryption.keySource | Microsoft.KeyVault |
Перечисляет возможное значение keySource для шифрования. |
|
properties.encryption.keyVaultProperties |
Свойства хранилища ключей |
||
properties.encryption.requireInfrastructureEncryption |
boolean |
Включение шифрования инфраструктуры (двойное шифрование) |
|
properties.isAutoInflateEnabled |
boolean |
Значение, указывающее, включена ли функция Автоинфляции для пространства имен концентратора событий. |
|
properties.kafkaEnabled |
boolean |
Значение, указывающее, включена ли Kafka для пространства имен концентратора событий. |
|
properties.maximumThroughputUnits |
integer |
Верхний предел единиц пропускной способности при включенном автоинфляции значение должно находиться в пределах от 0 до 20 единиц пропускной способности. ( '0', если AutoInflateEnabled = true) |
|
properties.metricId |
string |
Идентификатор для метрик Azure Insights. |
|
properties.minimumTlsVersion |
Минимальная версия TLS для поддержки кластера, например 1.2. |
||
properties.privateEndpointConnections |
Список подключений к частной конечной точке. |
||
properties.provisioningState |
string |
Состояние подготовки пространства имен. |
|
properties.publicNetworkAccess | Enabled |
Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. |
|
properties.serviceBusEndpoint |
string |
Конечную точку можно использовать для выполнения операций служебной шины. |
|
properties.status |
string |
Состояние пространства имен. |
|
properties.updatedAt |
string |
Время обновления пространства имен. |
|
properties.zoneRedundant |
boolean |
При включении этого свойства создается стандартное пространство имен Центров событий в регионах, поддерживаемых зонами доступности. |
|
sku |
Свойства ресурса SKU |
||
systemData |
Системные метаданные, относящиеся к этому ресурсу. |
||
tags |
object |
Теги ресурсов. |
|
type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
EndPointProvisioningState
Состояние подготовки подключения к частной конечной точке.
Имя | Тип | Описание |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ об ошибке указывает, что служба концентратора событий не может обработать входящий запрос. Причина указана в сообщении об ошибке.
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
keySource
Перечисляет возможное значение keySource для шифрования.
Имя | Тип | Описание |
---|---|---|
Microsoft.KeyVault |
string |
KeyVaultProperties
Свойства хранилища ключей
Имя | Тип | Описание |
---|---|---|
identity.userAssignedIdentity |
string |
Идентификатор ARM для удостоверения пользователя, выбранного для шифрования |
keyName |
string |
Имя ключа из Хранилища ключей |
keyVaultUri |
string |
URI хранилища ключей |
keyVersion |
string |
Версия ключа |
ManagedServiceIdentityType
Тип удостоверения управляемой службы.
Имя | Тип | Описание |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
PrivateEndpoint
Ресурс частной конечной точки для этого подключения.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ARM для частной конечной точки. |
PrivateEndpointConnection
Список подключений к частной конечной точке.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
Географическое расположение, в котором находится ресурс |
name |
string |
Имя ресурса. |
properties.privateEndpoint |
Ресурс частной конечной точки для этого подключения. |
|
properties.privateLinkServiceConnectionState |
Сведения о состоянии подключения. |
|
properties.provisioningState |
Состояние подготовки подключения к частной конечной точке. |
|
systemData |
Системные метаданные, относящиеся к этому ресурсу. |
|
type |
string |
Тип ресурса. Например, "Microsoft.EventHub/Namespaces" или "Microsoft.EventHub/Namespaces/EventHubs" |
PrivateLinkConnectionStatus
Состояние подключения.
Имя | Тип | Описание |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PublicNetworkAccess
Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен.
Имя | Тип | Описание |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
SecuredByPerimeter |
string |
Sku
Свойства ресурса SKU
Имя | Тип | Описание |
---|---|---|
capacity |
integer |
Единицы пропускной способности Центров событий для уровней "Базовый" или "Стандартный", где значение должно быть от 0 до 20 единиц пропускной способности. Единицы "Премиум" в Центрах событий для уровня "Премиум", где значение должно быть от 0 до 10 единиц уровня "Премиум". |
name |
Имя этого номера SKU. |
|
tier |
Уровень выставления счетов конкретного номера SKU. |
SkuName
Имя этого номера SKU.
Имя | Тип | Описание |
---|---|---|
Basic |
string |
|
Premium |
string |
|
Standard |
string |
SkuTier
Уровень выставления счетов конкретного номера SKU.
Имя | Тип | Описание |
---|---|---|
Basic |
string |
|
Premium |
string |
|
Standard |
string |
systemData
Метаданные, относящиеся к созданию и последнему изменению ресурса.
Имя | Тип | Описание |
---|---|---|
createdAt |
string |
Метка времени создания ресурса (UTC). |
createdBy |
string |
Удостоверение, создающее ресурс. |
createdByType |
Тип удостоверения, создавшего ресурс. |
|
lastModifiedAt |
string |
Тип удостоверения, изменяющего ресурс в последний раз. |
lastModifiedBy |
string |
Удостоверение, которое в последний раз изменял ресурс. |
lastModifiedByType |
Тип удостоверения, изменяющего ресурс в последний раз. |
TlsVersion
Минимальная версия TLS для поддержки кластера, например 1.2.
Имя | Тип | Описание |
---|---|---|
1.0 |
string |
|
1.1 |
string |
|
1.2 |
string |
UserAssignedIdentity
Распознанное значение словаря.
Имя | Тип | Описание |
---|---|---|
clientId |
string |
Идентификатор клиента удостоверения, назначаемого пользователем |
principalId |
string |
Идентификатор субъекта удостоверения, назначаемого пользователем |