Namespaces - Create Or Update

Ссылка

Служба:: Service Bus

Версия API:: 2024-01-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
namespaceName	path	True	string	Имя пространства имен.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

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

Имя	Обязательно	Тип	Описание
location	True	string	Географическое расположение, в котором находится ресурс
identity.type		ManagedServiceIdentityType	Тип управляемого удостоверения службы.
identity.userAssignedIdentities		<string, UserAssignedIdentity>	Свойства назначенных пользователем удостоверений
properties.alternateName		string	Альтернативное имя пространства имен
properties.disableLocalAuth		boolean	Это свойство отключает проверку подлинности SAS для пространства имен служебной шины.
properties.encryption.keySource		keySource	Перечисляет возможное значение keySource для шифрования
properties.encryption.keyVaultProperties		KeyVaultProperties[]	Свойства KeyVault
properties.encryption.requireInfrastructureEncryption		boolean	Включение шифрования инфраструктуры (двойное шифрование)
properties.minimumTlsVersion		TlsVersion	Минимальная версия TLS для кластера для поддержки, например 1.2.
properties.premiumMessagingPartitions		integer (int32)	Количество секций пространства имен служебной шины. Это свойство применимо только к пространствам имен SKU класса Premium. Значение по умолчанию равно 1 и возможные значения: 1, 2 и 4
properties.privateEndpointConnections		PrivateEndpointConnection[]	Список подключений к частной конечной точке.
properties.publicNetworkAccess		PublicNetworkAccess	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена.
properties.zoneRedundant		boolean	Включение этого свойства создает пространство имен служебной шины класса Premium в регионах, поддерживаемых зонами доступности.
sku		SBSku	Свойства SKU
tags		object	Теги ресурсов

Ответы

Имя	Тип	Описание
200 OK	SBNamespace	Пространство имен успешно создано.
201 Created	SBNamespace	Запрос на создание пространства имен принимается.
202 Accepted		Пространство имен создает или обновляет запрос на обновление, принятый.
Other Status Codes	ErrorResponse	Ответ об ошибке ServiceBus, описывающий причину сбоя операции.

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

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/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace2924?api-version=2024-01-01

{
  "sku": {
    "name": "Premium",
    "tier": "Premium",
    "capacity": 4
  },
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "premiumMessagingPartitions": 2
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ServiceBus.Models;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/NameSpaces/SBNameSpaceCreate.json
// this example is just showing the usage of "Namespaces_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
string resourceGroupName = "ArunMonocle";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ServiceBusNamespaceResource
ServiceBusNamespaceCollection collection = resourceGroupResource.GetServiceBusNamespaces();

// invoke the operation
string namespaceName = "sdk-Namespace2924";
ServiceBusNamespaceData data = new ServiceBusNamespaceData(new AzureLocation("South Central US"))
{
    Sku = new ServiceBusSku(ServiceBusSkuName.Premium)
    {
        Tier = ServiceBusSkuTier.Premium,
        Capacity = 4,
    },
    PremiumMessagingPartitions = 2,
    Tags =
    {
    ["tag1"] = "value1",
    ["tag2"] = "value2"
    },
};
ArmOperation<ServiceBusNamespaceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, namespaceName, data);
ServiceBusNamespaceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ServiceBusNamespaceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Код состояния:: 200

{
  "sku": {
    "name": "Premium",
    "tier": "Premium",
    "capacity": 4
  },
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924",
  "name": "sdk-Namespace-2924",
  "type": "Microsoft.ServiceBus/Namespaces",
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "provisioningState": "Created",
    "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924",
    "createdAt": "2017-05-25T22:26:36.76Z",
    "updatedAt": "2017-05-25T22:26:36.76Z",
    "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/",
    "minimumTlsVersion": "1.2",
    "premiumMessagingPartitions": 2
  }
}

Код состояния:: 201

{
  "sku": {
    "name": "Premium",
    "tier": "Premium",
    "capacity": 4
  },
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924",
  "name": "sdk-Namespace-2924",
  "type": "Microsoft.ServiceBus/Namespaces",
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "provisioningState": "Created",
    "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924",
    "createdAt": "2017-05-25T22:26:36.76Z",
    "updatedAt": "2017-05-25T22:26:36.76Z",
    "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/",
    "disableLocalAuth": false,
    "minimumTlsVersion": "1.2",
    "premiumMessagingPartitions": 2
  }
}

Код состояния:: 202

Определения

Имя	Описание
ConnectionState	Сведения о ConnectionState.
createdByType	Тип удостоверения, создавшего ресурс.
EndPointProvisioningState	Состояние подготовки подключения к частной конечной точке.
Error	Объект ошибки.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Ответ об ошибке управления ресурсами.
keySource	Перечисляет возможное значение keySource для шифрования
KeyVaultProperties	Свойства для настройки свойств keyVault
ManagedServiceIdentityType	Тип управляемого удостоверения службы.
PrivateEndpoint	Сведения о PrivateEndpoint.
PrivateEndpointConnection	Свойства PrivateEndpointConnection.
PrivateLinkConnectionStatus	Состояние подключения.
PublicNetworkAccess	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена.
SBNamespace	Описание ресурса пространства имен.
SBSku	Номер SKU пространства имен.
SkuName	Имя этого номера SKU.
SkuTier	Уровень выставления счетов конкретного номера SKU.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
TlsVersion	Минимальная версия TLS для кластера для поддержки, например 1.2.
UserAssignedIdentity	Распознаваемое значение словаря.

ConnectionState

Object

Сведения о ConnectionState.

Имя	Тип	Описание
description	string	Описание состояния подключения.
status	PrivateLinkConnectionStatus	Состояние подключения.

createdByType

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

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

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

EndPointProvisioningState

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

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

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

Error

Object

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorResponse[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorAdditionalInfo

Object

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorResponse

Object

Ответ об ошибке управления ресурсами.

Имя	Тип	Описание
error	Error	Объект ошибки.

keySource

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

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

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

KeyVaultProperties

Object

Свойства для настройки свойств keyVault

Имя	Тип	Описание
identity.userAssignedIdentity	string	Идентификатор ARM удостоверения пользователя, выбранного для шифрования
keyName	string	Имя ключа из KeyVault
keyVaultUri	string	Универсальный код ресурса (URI) keyVault
keyVersion	string	Версия KeyVault

ManagedServiceIdentityType

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

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

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

PrivateEndpoint

Object

Сведения о PrivateEndpoint.

Имя	Тип	Описание
id	string	Идентификатор ARM для частной конечной точки.

PrivateEndpointConnection

Object

Свойства PrivateEndpointConnection.

Имя	Тип	Описание
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

SBNamespace

Object

Описание ресурса пространства имен.

Имя	Тип	Default value	Описание
id	string		Идентификатор ресурса
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.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.metricId	string		Идентификатор метрик Azure Insights
properties.minimumTlsVersion	TlsVersion		Минимальная версия TLS для кластера для поддержки, например 1.2.
properties.premiumMessagingPartitions	integer (int32)		Количество секций пространства имен служебной шины. Это свойство применимо только к пространствам имен SKU класса Premium. Значение по умолчанию равно 1 и возможные значения: 1, 2 и 4
properties.privateEndpointConnections	PrivateEndpointConnection[]		Список подключений к частной конечной точке.
properties.provisioningState	string		Состояние подготовки пространства имен.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена.
properties.serviceBusEndpoint	string		Конечная точка, используемая для выполнения операций служебной шины.
properties.status	string		Состояние пространства имен.
properties.updatedAt	string (date-time)		Время обновления пространства имен.
properties.zoneRedundant	boolean		Включение этого свойства создает пространство имен служебной шины класса Premium в регионах, поддерживаемых зонами доступности.
sku	SBSku		Свойства SKU
systemData	systemData		Системные метаданные, относящиеся к этому ресурсу.
tags	object		Теги ресурсов
type	string		Тип ресурса

SBSku

Object

Номер SKU пространства имен.

Имя	Тип	Описание
capacity	integer (int32)	Единицы обмена сообщениями для пространства имен служебной шины premium. Допустимые емкости : {1, 2, 4, 8, 16} — несколько свойств.premiumMessagingPartitions. Например, если properties.premiumMessagingPartitions имеет значение 1, то возможные значения емкости : 1, 2, 4, 8 и 16. Если properties.premiumMessagingPartitions имеет значение 4, возможные значения емкости : 4, 8, 16, 32 и 64
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	Идентификатор участника назначаемого пользователем удостоверения

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

Namespaces - Create Or Update

Параметры URI

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

Ответы

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

azure_auth

Области

Примеры

NameSpaceCreate

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

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

Определения

ConnectionState

createdByType

EndPointProvisioningState

Error

ErrorAdditionalInfo

ErrorResponse

keySource

KeyVaultProperties

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

SBNamespace

SBSku

SkuName

SkuTier

systemData

TlsVersion

UserAssignedIdentity

Дополнительные ресурсы