Share via

Namespaces - Get

Service:
Relay
API Version:
2024-01-01

Returns the description for the specified namespace.

GET 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

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.

Responses

Name Type Description
200 OK

RelayNamespace

Azure operation completed successfully.
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

RelayNameSpaceGet

Sample request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01?api-version=2024-01-01

Sample response

Status code:
200 
{
  "name": "example-RelayRelayNamespace-01",
  "type": "Microsoft.Relay/Namespaces",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01",
  "location": "West US",
  "properties": {
    "createdAt": "2017-01-23T20:38:12.46Z",
    "metricId": "ffffffff-ffff-ffff-ffff-ffffffffffff:example-RelayRelayNamespace-01",
    "provisioningState": "Succeeded",
    "serviceBusEndpoint": "https://example-RelayRelayNamespace-01.servicebus.windows.net:443/",
    "updatedAt": "2017-01-23T20:38:34.533Z"
  },
  "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.

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.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.