Namespaces - Create Or Update

Service:

Relay

API Version:

2026-01-01

Create Azure Relay namespace.

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

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	The namespace name
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
properties.minimumTlsVersion		TlsVersion	The minimum TLS version for the namespace. Supported values are 1.2 and 1.3. The service defaults to 1.2 when the property is omitted. Existing namespaces configured with TLS 1.0 or 1.1 are reported as TLS 1.2.
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.
sku		Sku	SKU of the namespace.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	RelayNamespace	Resource 'RelayNamespace' update operation succeeded
201 Created	RelayNamespace	Resource 'RelayNamespace' create operation succeeded Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

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

RelayNamespaceCreate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5849?api-version=2026-01-01

{
  "location": "South Central US",
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "minimumTlsVersion": "1.2"
  }
}

Java

import com.azure.resourcemanager.relay.models.Sku;
import com.azure.resourcemanager.relay.models.SkuName;
import com.azure.resourcemanager.relay.models.SkuTier;
import com.azure.resourcemanager.relay.models.TlsVersion;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Namespaces CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-01-01/NameSpaces/RelayNameSpaceCreate.json
     */
    /**
     * Sample code: RelayNamespaceCreate.
     * 
     * @param manager Entry point to RelayManager.
     */
    public static void relayNamespaceCreate(com.azure.resourcemanager.relay.RelayManager manager) {
        manager.namespaces().define("example-RelayNamespace-5849").withRegion("South Central US")
            .withExistingResourceGroup("resourcegroup").withTags(mapOf("tag1", "value1", "tag2", "value2"))
            .withSku(new Sku().withName(SkuName.STANDARD).withTier(SkuTier.STANDARD))
            .withMinimumTlsVersion(TlsVersion.ONE_TWO).create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.relay import RelayAPIMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-relay
# USAGE
    python relay_name_space_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RelayAPIMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.namespaces.begin_create_or_update(
        resource_group_name="resourcegroup",
        namespace_name="example-RelayNamespace-5849",
        parameters={
            "location": "South Central US",
            "properties": {"minimumTlsVersion": "1.2"},
            "sku": {"name": "Standard", "tier": "Standard"},
            "tags": {"tag1": "value1", "tag2": "value2"},
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-01-01/NameSpaces/RelayNameSpaceCreate.json
if __name__ == "__main__":
    main()

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

Go

package armrelay_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
)

// Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceCreate.json
func ExampleNamespacesClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewNamespacesClient().BeginCreateOrUpdate(ctx, "resourcegroup", "example-RelayNamespace-5849", armrelay.Namespace{
		Location: to.Ptr("South Central US"),
		SKU: &armrelay.SKU{
			Name: to.Ptr(armrelay.SKUNameStandard),
			Tier: to.Ptr(armrelay.SKUTierStandard),
		},
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
		Properties: &armrelay.NamespaceProperties{
			MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armrelay.NamespacesClientCreateOrUpdateResponse{
	// 	Namespace: armrelay.Namespace{
	// 		Name: to.Ptr("example-RelayNamespace-5849"),
	// 		Type: to.Ptr("Microsoft.Relay/Namespaces"),
	// 		ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5849"),
	// 		Location: to.Ptr("South Central US"),
	// 		Properties: &armrelay.NamespaceProperties{
	// 			MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-5849"),
	// 			ProvisioningState: to.Ptr("Created"),
	// 			ServiceBusEndpoint: to.Ptr("https://example-RelayNamespace-5849.servicebus.windows-int.net:443/"),
	// 			MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
	// 		},
	// 		SKU: &armrelay.SKU{
	// 			Name: to.Ptr(armrelay.SKUNameStandard),
	// 			Tier: to.Ptr(armrelay.SKUTierStandard),
	// 		},
	// 		Tags: map[string]*string{
	// 			"tag1": to.Ptr("value1"),
	// 			"tag2": to.Ptr("value2"),
	// 		},
	// 	},
	// }
}

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

JavaScript

const { RelayAPI } = require("@azure/arm-relay");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create Azure Relay namespace.
 *
 * @summary create Azure Relay namespace.
 * x-ms-original-file: 2026-01-01/NameSpaces/RelayNameSpaceCreate.json
 */
async function relayNamespaceCreate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const client = new RelayAPI(credential, subscriptionId);
  const result = await client.namespaces.createOrUpdate(
    "resourcegroup",
    "example-RelayNamespace-5849",
    {
      location: "South Central US",
      sku: { name: "Standard", tier: "Standard" },
      tags: { tag1: "value1", tag2: "value2" },
      minimumTlsVersion: "1.2",
    },
  );
  console.log(result);
}

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

{
  "name": "example-RelayNamespace-5849",
  "type": "Microsoft.Relay/Namespaces",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5849",
  "location": "South Central US",
  "properties": {
    "metricId": "ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-5849",
    "provisioningState": "Created",
    "serviceBusEndpoint": "https://example-RelayNamespace-5849.servicebus.windows-int.net:443/",
    "minimumTlsVersion": "1.2"
  },
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Status code:

201

{
  "name": "example-RelayNamespace-5849",
  "type": "Microsoft.Relay/Namespaces",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5849",
  "location": "South Central US",
  "properties": {
    "metricId": "ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-5849",
    "provisioningState": "Created",
    "serviceBusEndpoint": "https://example-RelayNamespace-5849.servicebus.windows-int.net:443/",
    "minimumTlsVersion": "1.2"
  },
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Definitions

Name	Description
ConnectionState	ConnectionState information.
createdByType	The type of identity that created the resource.
EndPointProvisioningState	Provisioning state of the Private Endpoint Connection.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
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.
RelayNamespace	Description of a namespace resource.
Sku	SKU of the namespace.
SkuName	Name of this SKU.
SkuTier	The tier of this SKU.
systemData	Metadata pertaining to creation and last modification of the resource.
TlsVersion	TLS versions supported by Relay namespaces.

ConnectionState

Object

ConnectionState information.

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

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

EndPointProvisioningState

Enumeration

Provisioning state of the Private Endpoint Connection.

Value	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

The error detail.

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

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

PrivateEndpoint

Object

PrivateEndpoint information.

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

PrivateEndpointConnection

Object

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	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateLinkConnectionStatus

Enumeration

Status of the connection.

Value	Description
Pending
Approved
Rejected
Disconnected

PublicNetworkAccess

Enumeration

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

Value	Description
Enabled
Disabled
SecuredByPerimeter

RelayNamespace

Object

Description of a namespace resource.

Name	Type	Default value	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.createdAt	string (date-time)		The time the namespace was created.
properties.metricId	string		Identifier for Azure Insights metrics.
properties.minimumTlsVersion	TlsVersion		The minimum TLS version for the namespace. Supported values are 1.2 and 1.3. The service defaults to 1.2 when the property is omitted. Existing namespaces configured with TLS 1.0 or 1.1 are reported as TLS 1.2.
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 (date-time)		The time the namespace was updated.
sku	Sku		SKU of the namespace.
systemData	systemData		Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Sku

Object

SKU of the namespace.

Name	Type	Description
name	SkuName	Name of this SKU.
tier	SkuTier	The tier of this SKU.

SkuName

Enumeration

Name of this SKU.

Value	Description
Standard

SkuTier

Enumeration

The tier of this SKU.

Value	Description
Standard

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

TlsVersion

Enumeration

TLS versions supported by Relay namespaces.

Value	Description
1.2	TLS version 1.2.
1.3	TLS version 1.3.