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

Namespaces - Create Or Update

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

Создает или обновляет пространство имен. После создания манифест ресурса этого пространства имен неизменяем. Эта операция является идемпотентной.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}?api-version=2024-01-01

Параметры URI

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

string

minLength: 6
maxLength: 50
pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

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

string

minLength: 1
maxLength: 90

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

string

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

string

Версия КЛИЕНТСКОго API.

Текст запроса

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

EHNamespace

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

Ответы

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

EHNamespace

Пространство имен успешно создано.
201 Created

EHNamespace

Запрос на создание пространства имен принимается.
202 Accepted

Пространство имен создает или обновляет запрос на обновление, принятый.
Other Status Codes

ErrorResponse

Ответ об ошибке eventhub, описывающий, почему операция завершилась ошибкой.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

NamespaceCreate

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

PUT https://management.azure.com/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample?api-version=2024-01-01

{
  "location": "East US",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": {},
      "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": {}
    }
  },
  "properties": {
    "encryption": {
      "keyVaultProperties": [
        {
          "keyName": "Samplekey",
          "keyVaultUri": "https://aprao-keyvault-user.vault-int.azure-int.net/",
          "identity": {
            "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1"
          }
        }
      ],
      "keySource": "Microsoft.KeyVault"
    },
    "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test"
  }
}

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

Код состояния:
200 
{
  "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": {
    "zoneRedundant": false,
    "isAutoInflateEnabled": false,
    "disableLocalAuth": false,
    "maximumThroughputUnits": 0,
    "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
    },
    "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test",
    "kafkaEnabled": false,
    "provisioningState": "Succeeded",
    "metricId": "MetricGUID:NamespaceSample",
    "createdAt": "2021-02-16T22:36:06.107Z",
    "updatedAt": "2021-02-16T22:37:42.29Z",
    "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443/"
  }
}
Код состояния:
201 
{
  "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": {
    "zoneRedundant": false,
    "isAutoInflateEnabled": false,
    "disableLocalAuth": false,
    "maximumThroughputUnits": 0,
    "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
    },
    "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test",
    "kafkaEnabled": false,
    "provisioningState": "Succeeded",
    "metricId": "MetricGUID:NamespaceSample",
    "createdAt": "2021-02-16T22:36:06.107Z",
    "updatedAt": "2021-02-16T22:37:42.29Z",
    "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443/"
  }
}
Код состояния:
202

Определения

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

Сведения о состоянии подключения.
createdByType

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

Элемент единого пространства имен в списке или операции получения
EndPointProvisioningState

Состояние подготовки подключения к частной конечной точке.
ErrorAdditionalInfo

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

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

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

Перечисляет возможное значение keySource для шифрования
KeyVaultProperties

Свойства KeyVault
ManagedServiceIdentityType

Тип управляемого удостоверения службы.
PrivateEndpoint

Ресурс частной конечной точки для этого подключения.
PrivateEndpointConnection

Список подключений к частной конечной точке.
PrivateLinkConnectionStatus

Состояние подключения.
PublicNetworkAccess

Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена.
Sku

Свойства ресурса SKU
SkuName

Имя этого номера SKU.
SkuTier

Уровень выставления счетов конкретного номера SKU.
systemData

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

Минимальная версия TLS для кластера для поддержки, например 1.2.
UserAssignedIdentity

Распознаваемое значение словаря.

ConnectionState

Object

Сведения о состоянии подключения.

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

string

Описание состояния подключения.
status

PrivateLinkConnectionStatus

Состояние подключения.

createdByType

Перечисление

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

Значение Описание
Application
Key
ManagedIdentity
User

EHNamespace

Object

Элемент единого пространства имен в списке или операции получения

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

string

Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId

string

ObjectId из KeyVault
identity.tenantId

string

TenantId из KeyVault
identity.type

ManagedServiceIdentityType

Тип управляемого удостоверения службы.
identity.userAssignedIdentities

<string,  UserAssignedIdentity>

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

string

Расположение ресурса.
name

string

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

string

Альтернативное имя, указанное при одинаковых именах псевдонимов и пространств имен.
properties.clusterArmId

string

Идентификатор ARM кластера пространства имен.
properties.createdAt

string (date-time)

Время создания пространства имен.
properties.disableLocalAuth

boolean

Это свойство отключает проверку подлинности SAS для пространства имен Центров событий.
properties.encryption.keySource

keySource

Microsoft.KeyVault

Перечисляет возможное значение keySource для шифрования
properties.encryption.keyVaultProperties

KeyVaultProperties[]

Свойства KeyVault
properties.encryption.requireInfrastructureEncryption

boolean

Включение шифрования инфраструктуры (двойное шифрование)
properties.isAutoInflateEnabled

boolean

Значение, указывающее, включена ли функция AutoInflate для пространства имен концентратора событий.
properties.kafkaEnabled

boolean

Значение, указывающее, включена ли Kafka для пространства имен eventhub.
properties.maximumThroughputUnits

integer (int32)

minimum: 0

Максимальное ограничение единиц пропускной способности при включении AutoInflate должно находиться в пределах 0 до 20 единиц пропускной способности. ( "0", если AutoInflateEnabled = true)
properties.metricId

string

Идентификатор метрик Azure Insights.
properties.minimumTlsVersion

TlsVersion

Минимальная версия TLS для кластера для поддержки, например 1.2.
properties.privateEndpointConnections

PrivateEndpointConnection[]

Список подключений к частной конечной точке.
properties.provisioningState

string

Состояние подготовки пространства имен.
properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена.
properties.serviceBusEndpoint

string

Конечная точка, используемая для выполнения операций служебной шины.
properties.status

string

Состояние пространства имен.
properties.updatedAt

string (date-time)

Время обновления пространства имен.
properties.zoneRedundant

boolean

Включение этого свойства создает пространство имен Центров событий уровня "Стандартный" в регионах, поддерживаемых зонами доступности.
sku

Sku

Свойства ресурса SKU
systemData

systemData

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

object

Теги ресурсов.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

EndPointProvisioningState

Перечисление

Состояние подготовки подключения к частной конечной точке.

Значение Описание
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ErrorAdditionalInfo

Object

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

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

object

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

string

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

ErrorDetail

Object

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

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

ErrorAdditionalInfo[]

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

string

Код ошибки.
details

ErrorDetail[]

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

string

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

string

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

ErrorResponse

Object

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

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

ErrorDetail

Объект ошибки.

keySource

Перечисление

Перечисляет возможное значение keySource для шифрования

Значение Описание
Microsoft.KeyVault

KeyVaultProperties

Object

Свойства KeyVault

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

string

Идентификатор ARM удостоверения пользователя, выбранного для шифрования
keyName

string

Имя ключа из KeyVault
keyVaultUri

string

Универсальный код ресурса (URI) keyVault
keyVersion

string

Версия ключа

ManagedServiceIdentityType

Перечисление

Тип управляемого удостоверения службы.

Значение Описание
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateEndpoint

Object

Ресурс частной конечной точки для этого подключения.

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

string

Идентификатор ARM для частной конечной точки.

PrivateEndpointConnection

Object

Список подключений к частной конечной точке.

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

string

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

string

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

string

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

PrivateEndpoint

Ресурс частной конечной точки для этого подключения.
properties.privateLinkServiceConnectionState

ConnectionState

Сведения о состоянии подключения.
properties.provisioningState

EndPointProvisioningState

Состояние подготовки подключения к частной конечной точке.
systemData

systemData

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

string

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

PrivateLinkConnectionStatus

Перечисление

Состояние подключения.

Значение Описание
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Перечисление

Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена.

Значение Описание
Disabled
Enabled
SecuredByPerimeter

Sku

Object

Свойства ресурса SKU

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

integer (int32)

minimum: 0

Единицы пропускной способности Центров событий для уровней "Базовый" или "Стандартный", где значение должно составлять от 0 до 20 единиц пропускной способности. Единицы уровня "Премиум" центров событий для уровня "Премиум", где значение должно составлять от 0 до 10 единиц уровня "Премиум".
name

SkuName

Имя этого номера SKU.
tier

SkuTier

Уровень выставления счетов конкретного номера SKU.

SkuName

Перечисление

Имя этого номера SKU.

Значение Описание
Basic
Premium
Standard

SkuTier

Перечисление

Уровень выставления счетов конкретного номера SKU.

Значение Описание
Basic
Premium
Standard

systemData

Object

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

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

string (date-time)

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

string

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

createdByType

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

string (date-time)

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

string

Идентификатор, который последний раз изменил ресурс.
lastModifiedByType

createdByType

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

TlsVersion

Перечисление

Минимальная версия TLS для кластера для поддержки, например 1.2.

Значение Описание
1.0
1.1
1.2

UserAssignedIdentity

Object

Распознаваемое значение словаря.

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

string

Идентификатор клиента назначаемого пользователем удостоверения
principalId

string

Идентификатор участника назначаемого пользователем удостоверения