Namespaces - Create Or Update

Reference

Service:: Service Bus

API Version:: 2024-01-01

Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

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

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string	The namespace name.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The Geo-location where the resource lives
identity.type		ManagedServiceIdentityType	Type of managed service identity.
identity.userAssignedIdentities		<string, UserAssignedIdentity>	Properties for User Assigned Identities
properties.alternateName		string	Alternate name for namespace
properties.disableLocalAuth		boolean	This property disables SAS authentication for the Service Bus namespace.
properties.encryption.keySource		keySource	Enumerates the possible value of keySource for Encryption
properties.encryption.keyVaultProperties		KeyVaultProperties[]	Properties of KeyVault
properties.encryption.requireInfrastructureEncryption		boolean	Enable Infrastructure Encryption (Double Encryption)
properties.minimumTlsVersion		TlsVersion	The minimum TLS version for the cluster to support, e.g. '1.2'
properties.premiumMessagingPartitions		integer	The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4
properties.privateEndpointConnections		PrivateEndpointConnection[]	List of private endpoint connections.
properties.publicNetworkAccess		PublicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled.
properties.zoneRedundant		boolean	Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.
sku		SBSku	Properties of SKU
tags		object	Resource tags

Responses

Name	Type	Description
200 OK	SBNamespace	Namespace created successfully.
201 Created	SBNamespace	Namespace create request accepted.
202 Accepted		Namespace create or update request accepted.
Other Status Codes	ErrorResponse	ServiceBus error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

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

Sample response

Status code:: 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
  }
}

Status code:: 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
  }
}

Status code:: 202

Definitions

Name	Description
ConnectionState	ConnectionState information.
createdByType	The type of identity that created the resource.
EndPointProvisioningState	Provisioning state of the Private Endpoint Connection.
Error	The error object.
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	The resource management error response.
keySource	Enumerates the possible value of keySource for Encryption
KeyVaultProperties	Properties to configure keyVault Properties
ManagedServiceIdentityType	Type of managed service identity.
PrivateEndpoint	PrivateEndpoint information.
PrivateEndpointConnection	Properties of the PrivateEndpointConnection.
PrivateLinkConnectionStatus	Status of the connection.
PublicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled.
SBNamespace	Description of a namespace resource.
SBSku	SKU of the namespace.
SkuName	Name of this SKU.
SkuTier	The billing tier of this particular SKU.
systemData	Metadata pertaining to creation and last modification of the resource.
TlsVersion	The minimum TLS version for the cluster to support, e.g. '1.2'
UserAssignedIdentity	Recognized Dictionary value.

ConnectionState

ConnectionState information.

Name	Type	Description
description	string	Description of the connection state.
status	PrivateLinkConnectionStatus	Status of the connection.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EndPointProvisioningState

Provisioning state of the Private Endpoint Connection.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

Error

The error object.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorResponse[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorResponse

The resource management error response.

Name	Type	Description
error	Error	The error object.

keySource

Enumerates the possible value of keySource for Encryption

Name	Type	Description
Microsoft.KeyVault	string

KeyVaultProperties

Properties to configure keyVault Properties

Name	Type	Description
identity.userAssignedIdentity	string	ARM ID of user Identity selected for encryption
keyName	string	Name of the Key from KeyVault
keyVaultUri	string	Uri of KeyVault
keyVersion	string	Version of KeyVault

ManagedServiceIdentityType

Type of managed service identity.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

PrivateEndpoint information.

Name	Type	Description
id	string	The ARM identifier for Private Endpoint.

PrivateEndpointConnection

Properties of the PrivateEndpointConnection.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.privateEndpoint	PrivateEndpoint	The Private Endpoint resource for this Connection.
properties.privateLinkServiceConnectionState	ConnectionState	Details about the state of the connection.
properties.provisioningState	EndPointProvisioningState	Provisioning state of the Private Endpoint Connection.
systemData	systemData	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Status of the connection.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled.

Name	Type	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

SBNamespace

Description of a namespace resource.

Name	Type	Default value	Description
id	string		Resource Id
identity.principalId	string		ObjectId from the KeyVault
identity.tenantId	string		TenantId from the KeyVault
identity.type	ManagedServiceIdentityType		Type of managed service identity.
identity.userAssignedIdentities	<string, UserAssignedIdentity>		Properties for User Assigned Identities
location	string		The Geo-location where the resource lives
name	string		Resource name
properties.alternateName	string		Alternate name for namespace
properties.createdAt	string		The time the namespace was created
properties.disableLocalAuth	boolean		This property disables SAS authentication for the Service Bus namespace.
properties.encryption.keySource	keySource	Microsoft.KeyVault	Enumerates the possible value of keySource for Encryption
properties.encryption.keyVaultProperties	KeyVaultProperties[]		Properties of KeyVault
properties.encryption.requireInfrastructureEncryption	boolean		Enable Infrastructure Encryption (Double Encryption)
properties.metricId	string		Identifier for Azure Insights metrics
properties.minimumTlsVersion	TlsVersion		The minimum TLS version for the cluster to support, e.g. '1.2'
properties.premiumMessagingPartitions	integer		The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4
properties.privateEndpointConnections	PrivateEndpointConnection[]		List of private endpoint connections.
properties.provisioningState	string		Provisioning state of the namespace.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	This determines if traffic is allowed over public network. By default it is enabled.
properties.serviceBusEndpoint	string		Endpoint you can use to perform Service Bus operations.
properties.status	string		Status of the namespace.
properties.updatedAt	string		The time the namespace was updated.
properties.zoneRedundant	boolean		Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.
sku	SBSku		Properties of SKU
systemData	systemData		The system meta data relating to this resource.
tags	object		Resource tags
type	string		Resource type

SBSku

SKU of the namespace.

Name	Type	Description
capacity	integer	Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64
name	SkuName	Name of this SKU.
tier	SkuTier	The billing tier of this particular SKU.

SkuName

Name of this SKU.

Name	Type	Description
Basic	string
Premium	string
Standard	string

SkuTier

The billing tier of this particular SKU.

Name	Type	Description
Basic	string
Premium	string
Standard	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The type of identity that last modified the resource.
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

TlsVersion

The minimum TLS version for the cluster to support, e.g. '1.2'

Name	Type	Description
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

Recognized Dictionary value.

Name	Type	Description
clientId	string	Client Id of user assigned identity
principalId	string	Principal Id of user assigned identity

Compartilhar via