Namespaces - Get

Service:

Device Registry

API Version:

2026-04-01

Get a Namespace

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

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	The name of the namespace.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Namespace	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

Get_Namespace

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DeviceRegistry/namespaces/adr-namespace-gbk0925-n01?api-version=2026-04-01

Sample response

Status code:

200

{
  "id": "/subscriptions/00000000-1366-430f-0000-cc873bcf2d27/resourceGroups/gbktestRG/providers/Microsoft.DeviceRegistry/namespaces/adr-namespace-gbk1001-n01",
  "name": "adr-namespace-gbk1001-n01",
  "type": "Microsoft.DeviceRegistry/namespaces",
  "location": "North Europe",
  "systemData": {
    "createdBy": "00003442-0000-0000-0000-494059220000",
    "createdByType": "Application",
    "createdAt": "2024-10-01T21:39:27.7050447Z",
    "lastModifiedBy": "00003442-0000-0000-0000-494059220000",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2024-10-01T21:39:27.7050447Z"
  },
  "identity": {
    "principalId": "4a06b859-8c07-4d9f-822d-3348a09f72c2",
    "tenantId": "0006f47a-0000-0000-0000-99be82dea000",
    "type": "SystemAssigned"
  },
  "properties": {
    "uuid": "cfbef47a-6971-4c90-a7a9-99be82dea167",
    "messaging": {
      "endpoints": {
        "myPrimaryEventGridEndpoint": {
          "address": "https://myeventgridtopic1.westeurope-1.eventgrid.azure.net",
          "endpointType": "Microsoft.Devices/IoTHubs"
        },
        "mySecondaryEventGridEndpoint": {
          "address": "https://myeventgridtopic2.westeurope-1.eventgrid.azure.net",
          "endpointType": "Microsoft.Devices/IoTHubs"
        }
      }
    },
    "provisioningState": "Succeeded"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Management	The namespace management endpoints model.
ManagementEndpoint	Namespace management endpoint model used by service to connect to device.
Messaging	The namespace messaging endpoints model.
MessagingEndpoint	Namespace messaging endpoint model used by a device to connect to a service.
Namespace	Namespace definition.
ProvisioningState	The provisioning status of the resource.
SystemAssignedServiceIdentity	Managed service identity (either system assigned, or none)
SystemAssignedServiceIdentityType	Type of managed service identity (either system assigned, or none).
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

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.

Management

Object

The namespace management endpoints model.

Name	Type	Description
endpoints	<string,  ManagementEndpoint>	Dictionary of management endpoints.

ManagementEndpoint

Object

Namespace management endpoint model used by service to connect to device.

Name	Type	Description
address	string	The endpoint address to connect to.
endpointType	string	Type of connection used for management endpoint.
resourceId	string	The messaging endpoint Azure resource Id.
scopeId	string	The scope ID for the management endpoint.

Messaging

Object

The namespace messaging endpoints model.

Name	Type	Description
endpoints	<string,  MessagingEndpoint>	Dictionary of messaging endpoints.

MessagingEndpoint

Object

Namespace messaging endpoint model used by a device to connect to a service.

Name	Type	Description
address	string	The endpoint address to connect to.
endpointType	string	Type of connection used for messaging endpoint.
resourceId	string	The messaging endpoint Azure resource Id.

Namespace

Object

Namespace definition.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	SystemAssignedServiceIdentity	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.management	Management	Assigned and unassigned management endpoints.
properties.messaging	Messaging	Assigned and unassigned messaging endpoints.
properties.provisioningState	ProvisioningState	Provisioning state of the resource.
properties.uuid	string	Globally unique, immutable, non-reusable ID.
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"

ProvisioningState

Enumeration

The provisioning status of the resource.

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.
Accepted	Resource has been accepted by the server.
Deleting	Resource is deleting.

SystemAssignedServiceIdentity

Object

Managed service identity (either system assigned, or none)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	SystemAssignedServiceIdentityType	Type of managed service identity (either system assigned, or none).

SystemAssignedServiceIdentityType

Enumeration

Type of managed service identity (either system assigned, or none).

Value	Description
None
SystemAssigned

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.