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

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

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

Шаблон регулярного выражения: ^[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 клиента.

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

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

EHNamespace

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

Ответы

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

EHNamespace

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

EHNamespace

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

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

ErrorResponse

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

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

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

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

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

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

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

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

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

Свойства Хранилища ключей
ManagedServiceIdentityType

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

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

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

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

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

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

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

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

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

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

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

ConnectionState

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

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

string

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

PrivateLinkConnectionStatus

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

createdByType

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

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

string

Key

string

ManagedIdentity

string

User

string

EHNamespace

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

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

string

Полный идентификатор ресурса. Например: /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

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

boolean

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

keySource

Microsoft.KeyVault

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

KeyVaultProperties[]

Свойства Хранилища ключей
properties.encryption.requireInfrastructureEncryption

boolean

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

boolean

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

boolean

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

integer

Верхний предел единиц пропускной способности при включенном автоинфляции значение должно находиться в пределах от 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

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

boolean

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

Sku

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

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

ErrorAdditionalInfo[]

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

string

Код ошибки.
details

ErrorDetail[]

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

string

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

string

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

ErrorResponse

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

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

ErrorDetail

Объект error.

keySource

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

Имя Тип Описание
Microsoft.KeyVault

string

KeyVaultProperties

Свойства Хранилища ключей

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

string

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

string

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

string

Универсальный код ресурса (URI) keyVault
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

PrivateEndpoint

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

ConnectionState

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

EndPointProvisioningState

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

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

SkuName

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

SkuTier

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

SkuName

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

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

string

Premium

string

Standard

string

SkuTier

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

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

string

Premium

string

Standard

string

systemData

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

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

string

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

string

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

createdByType

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

string

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

string

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

createdByType

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

TlsVersion

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

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

string

1.1

string

1.2

string

UserAssignedIdentity

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

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

string

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

string

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