Namespaces - Create Or Update

Service:

Relay

API Version:

2024-01-01

Create Azure Relay namespace.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/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	Name of the Resource group within the Azure subscription.
subscriptionId	path	True	string	Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Request Body

Name	Type	Description
parameters	RelayNamespace	Parameters supplied to create a namespace resource.

Responses

Name	Type	Description
200 OK	RelayNamespace	Namespace create request succeeded.
201 Created	RelayNamespace	Namespace create request accepted.
Other Status Codes	ErrorResponse	Relay 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

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=2024-01-01

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

Sample response

Status code:

200

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

Status code:

201

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

Definitions

Name	Description
ConnectionState	Details about the state of the connection.
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	The Private Endpoint resource for this Connection.
PrivateEndpointConnection	List of private endpoint connections.
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.

ConnectionState

Details about the state of the connection.

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

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorDetail

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

Error response

Name	Type	Description
error	ErrorDetail	The error object.

PrivateEndpoint

The Private Endpoint resource for this Connection.

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

PrivateEndpointConnection

List of private endpoint connections.

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

RelayNamespace

Description of a namespace resource.

Name	Type	Default value	Description
id	string		Resource ID.
location	string		Resource location.
name	string		Resource name.
properties.createdAt	string		The time the namespace was created.
properties.metricId	string		Identifier for Azure Insights metrics.
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.
sku	Sku		SKU of the namespace.
systemData	systemData		The system meta data relating to this resource.
tags	object		Resource tags.
type	string		Resource type.

Sku

SKU of the namespace.

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

SkuName

Name of this SKU.

Name	Type	Description
Standard	string

SkuTier

The tier of this SKU.

Name	Type	Description
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 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.