Namespaces - Get

Service:: Notification Hubs

API Version:: 2023-09-01

Returns the given namespace.

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

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]*$	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 (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	NamespaceResource	Success
Other Status Codes	ErrorResponse	Error code with reason.

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

Namespaces_Get

Sample request

HTTP

GET https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns?api-version=2023-09-01

Sample response

Status code:: 200

{
  "location": "East US",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "name": "nh-sdk-ns",
    "provisioningState": "Succeeded",
    "status": "Created",
    "enabled": true,
    "critical": false,
    "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40",
    "createdAt": "2023-04-26T06:10:44.01+00:00",
    "updatedAt": "2023-04-26T06:10:44.03+00:00",
    "namespaceType": "NotificationHub",
    "publicNetworkAccess": "Enabled",
    "networkAcls": {
      "ipRules": [
        {
          "ipMask": "185.48.100.00/24",
          "rights": [
            "Manage",
            "Send",
            "Listen"
          ]
        }
      ],
      "publicNetworkRule": {
        "rights": [
          "Listen"
        ]
      }
    },
    "serviceBusEndpoint": "https://nh-sdk-ns.servicebus.windows.net:443/",
    "privateEndpointConnections": []
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns",
  "name": "nh-sdk-ns",
  "type": "Microsoft.NotificationHubs/namespaces",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Definitions

Name	Description
AccessRights	Defines values for AccessRights.
AdmCredential	Description of a NotificationHub AdmCredential.
AdmCredentialProperties	Description of a NotificationHub AdmCredential.
ApnsCredential	Description of a NotificationHub ApnsCredential.
ApnsCredentialProperties	Description of a NotificationHub ApnsCredential.
BaiduCredential	Description of a NotificationHub BaiduCredential.
BaiduCredentialProperties	Description of a NotificationHub BaiduCredential.
BrowserCredential	Description of a NotificationHub BrowserCredential.
BrowserCredentialProperties	Description of a NotificationHub BrowserCredential.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GcmCredential	Description of a NotificationHub GcmCredential.
GcmCredentialProperties	Description of a NotificationHub GcmCredential.
IpRule	A network authorization rule that filters traffic based on IP address.
MpnsCredential	Description of a NotificationHub MpnsCredential.
MpnsCredentialProperties	Description of a NotificationHub MpnsCredential.
NamespaceProperties	Represents namespace properties.
NamespaceResource	Notification Hubs Namespace Resource.
NamespaceStatus	Namespace status.
NamespaceType	Defines values for NamespaceType.
NetworkAcls	A collection of network authorization rules.
OperationProvisioningState	Defines values for OperationProvisioningState.
PnsCredentials	Collection of Notification Hub or Notification Hub Namespace PNS credentials.
PrivateEndpointConnectionProperties	Private Endpoint Connection properties.
PrivateEndpointConnectionProvisioningState	State of Private Endpoint Connection.
PrivateEndpointConnectionResource	Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace.
PrivateLinkConnectionStatus	State of Private Link Connection.
PublicInternetAuthorizationRule	A default (public Internet) network authorization rule, which contains rights if no other network rule matches.
PublicNetworkAccess	Type of public network access.
RemotePrivateEndpointConnection	Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection.
RemotePrivateLinkServiceConnectionState	State of the Private Link Service connection.
ReplicationRegion	Allowed replication region
Sku	The Sku description for a namespace
SkuName	Namespace SKU name.
systemData	Metadata pertaining to creation and last modification of the resource.
WnsCredential	Description of a NotificationHub WnsCredential.
WnsCredentialProperties	Description of a NotificationHub WnsCredential.
XiaomiCredential	Description of a NotificationHub XiaomiCredential.
XiaomiCredentialProperties	Description of a NotificationHub XiaomiCredentialProperties.
ZoneRedundancyPreference	Namespace SKU name.

AccessRights

Enumeration

Defines values for AccessRights.

Value	Description
Manage
Send
Listen

AdmCredential

Object

Description of a NotificationHub AdmCredential.

Name	Type	Description
properties	AdmCredentialProperties	Description of a NotificationHub AdmCredential.

AdmCredentialProperties

Object

Description of a NotificationHub AdmCredential.

Name	Type	Description
authTokenUrl	string minLength: 1	Gets or sets the URL of the authorization token.
clientId	string minLength: 1	Gets or sets the client identifier.
clientSecret	string minLength: 1	Gets or sets the credential secret access key.

ApnsCredential

Object

Description of a NotificationHub ApnsCredential.

Name	Type	Description
properties	ApnsCredentialProperties	Description of a NotificationHub ApnsCredential.

ApnsCredentialProperties

Object

Description of a NotificationHub ApnsCredential.

Name	Type	Description
apnsCertificate	string	Gets or sets the APNS certificate.
appId	string	Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account
appName	string	Gets or sets the name of the application
certificateKey	string	Gets or sets the certificate key.
endpoint	string minLength: 1	Gets or sets the endpoint of this credential.
keyId	string	Gets or sets a 10-character key identifier (kid) key, obtained from your developer account
thumbprint	string	Gets or sets the APNS certificate Thumbprint
token	string	Gets or sets provider Authentication Token, obtained through your developer account

BaiduCredential

Object

Description of a NotificationHub BaiduCredential.

Name	Type	Description
properties	BaiduCredentialProperties	Description of a NotificationHub BaiduCredential.

BaiduCredentialProperties

Object

Description of a NotificationHub BaiduCredential.

Name	Type	Description
baiduApiKey	string minLength: 1	Gets or sets baidu Api Key.
baiduEndPoint	string minLength: 1	Gets or sets baidu Endpoint.
baiduSecretKey	string minLength: 1	Gets or sets baidu Secret Key

BrowserCredential

Object

Description of a NotificationHub BrowserCredential.

Name	Type	Description
properties	BrowserCredentialProperties	Description of a NotificationHub BrowserCredential.

BrowserCredentialProperties

Object

Description of a NotificationHub BrowserCredential.

Name	Type	Description
subject	string minLength: 1	Gets or sets web push subject.
vapidPrivateKey	string minLength: 1	Gets or sets VAPID private key.
vapidPublicKey	string minLength: 1	Gets or sets VAPID public key.

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.

GcmCredential

Object

Description of a NotificationHub GcmCredential.

Name	Type	Description
properties	GcmCredentialProperties	Description of a NotificationHub GcmCredential.

GcmCredentialProperties

Object

Description of a NotificationHub GcmCredential.

Name	Type	Description
gcmEndpoint	string	Gets or sets the GCM endpoint.
googleApiKey	string minLength: 1	Gets or sets the Google API key.

IpRule

Object

A network authorization rule that filters traffic based on IP address.

Name	Type	Description
ipMask	string minLength: 1	IP mask.
rights	AccessRights[]	List of access rights.

MpnsCredential

Object

Description of a NotificationHub MpnsCredential.

Name	Type	Description
properties	MpnsCredentialProperties	Description of a NotificationHub MpnsCredential.

MpnsCredentialProperties

Object

Description of a NotificationHub MpnsCredential.

Name	Type	Description
certificateKey	string minLength: 1	Gets or sets the certificate key for this credential.
mpnsCertificate	string minLength: 1	Gets or sets the MPNS certificate.
thumbprint	string minLength: 1	Gets or sets the MPNS certificate Thumbprint

NamespaceProperties

Object

Represents namespace properties.

Name	Type	Default value	Description
createdAt	string (date-time)		Time when the namespace was created.
critical	boolean		Gets or sets whether or not the namespace is set as Critical.
dataCenter	string		Deprecated.
enabled	boolean		Gets or sets whether or not the namespace is currently enabled.
metricId	string		Azure Insights Metrics id.
name	string		Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created.
namespaceType	NamespaceType		Defines values for NamespaceType.
networkAcls	NetworkAcls		A collection of network authorization rules.
pnsCredentials	PnsCredentials		Collection of Notification Hub or Notification Hub Namespace PNS credentials.
privateEndpointConnections	PrivateEndpointConnectionResource[]		Private Endpoint Connections for namespace
provisioningState	OperationProvisioningState		Defines values for OperationProvisioningState.
publicNetworkAccess	PublicNetworkAccess	Enabled	Type of public network access.
region	string		Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property.
replicationRegion	ReplicationRegion		Allowed replication region
scaleUnit	string		Gets or sets scaleUnit where the namespace gets created
serviceBusEndpoint	string		Gets or sets endpoint you can use to perform NotificationHub operations.
status	NamespaceStatus		Namespace status.
subscriptionId	string		Namespace subscription id.
updatedAt	string (date-time)		Time when the namespace was updated.
zoneRedundancy	ZoneRedundancyPreference	Disabled	Namespace SKU name.

NamespaceResource

Object

Notification Hubs Namespace Resource.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/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	NamespaceProperties	Represents namespace properties.
sku	Sku	The Sku description for a 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"

NamespaceStatus

Enumeration

Namespace status.

Value	Description
Created
Creating
Suspended
Deleting

NamespaceType

Enumeration

Defines values for NamespaceType.

Value	Description
Messaging
NotificationHub

NetworkAcls

Object

A collection of network authorization rules.

Name	Type	Description
ipRules	IpRule[]	List of IP rules.
publicNetworkRule	PublicInternetAuthorizationRule	A default (public Internet) network authorization rule, which contains rights if no other network rule matches.

OperationProvisioningState

Enumeration

Defines values for OperationProvisioningState.

Value	Description
Unknown
InProgress
Succeeded
Failed
Canceled
Pending
Disabled

PnsCredentials

Object

Collection of Notification Hub or Notification Hub Namespace PNS credentials.

Name	Type	Description
admCredential	AdmCredential	Description of a NotificationHub AdmCredential.
apnsCredential	ApnsCredential	Description of a NotificationHub ApnsCredential.
baiduCredential	BaiduCredential	Description of a NotificationHub BaiduCredential.
browserCredential	BrowserCredential	Description of a NotificationHub BrowserCredential.
gcmCredential	GcmCredential	Description of a NotificationHub GcmCredential.
mpnsCredential	MpnsCredential	Description of a NotificationHub MpnsCredential.
wnsCredential	WnsCredential	Description of a NotificationHub WnsCredential.
xiaomiCredential	XiaomiCredential	Description of a NotificationHub XiaomiCredential.

PrivateEndpointConnectionProperties

Object

Private Endpoint Connection properties.

Name	Type	Description
groupIds	string[]	List of group ids. For Notification Hubs, it always contains a single "namespace" element.
privateEndpoint	RemotePrivateEndpointConnection	Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection.
privateLinkServiceConnectionState	RemotePrivateLinkServiceConnectionState	State of the Private Link Service connection.
provisioningState	PrivateEndpointConnectionProvisioningState	State of Private Endpoint Connection.

PrivateEndpointConnectionProvisioningState

Enumeration

State of Private Endpoint Connection.

Value	Description
Unknown
Succeeded
Creating
Updating
UpdatingByProxy
Deleting
DeletingByProxy
Deleted

PrivateEndpointConnectionResource

Object

Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	PrivateEndpointConnectionProperties	Private Endpoint Connection properties.
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

State of Private Link Connection.

Value	Description
Disconnected
Pending
Approved
Rejected

PublicInternetAuthorizationRule

Object

A default (public Internet) network authorization rule, which contains rights if no other network rule matches.

Name	Type	Description
rights	AccessRights[]	List of access rights.

PublicNetworkAccess

Enumeration

Type of public network access.

Value	Description
Enabled
Disabled

RemotePrivateEndpointConnection

Object

Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection.

Name	Type	Description
id	string	ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace.

RemotePrivateLinkServiceConnectionState

Object

State of the Private Link Service connection.

Name	Type	Description
actionsRequired	string	Human-friendly description of required actions.
description	string	Human-friendly description.
status	PrivateLinkConnectionStatus	State of Private Link Connection.

ReplicationRegion

Enumeration

Allowed replication region

Value	Description
Default
WestUs2
NorthEurope
AustraliaEast
BrazilSouth
SouthEastAsia
SouthAfricaNorth
None

Sku

Object

The Sku description for a namespace

Name	Type	Description
capacity	integer (int32)	Gets or sets the capacity of the resource
family	string	Gets or sets the Sku Family
name	SkuName	Namespace SKU name.
size	string	Gets or sets the Sku size
tier	string	Gets or sets the tier of particular sku

SkuName

Enumeration

Namespace SKU name.

Value	Description
Free
Basic
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.

WnsCredential

Object

Description of a NotificationHub WnsCredential.

Name	Type	Description
properties	WnsCredentialProperties	Description of a NotificationHub WnsCredential.

WnsCredentialProperties

Object

Description of a NotificationHub WnsCredential.

Name	Type	Description
certificateKey	string	Ges or sets the WNS Certificate Key.
packageSid	string	Gets or sets the package ID for this credential.
secretKey	string	Gets or sets the secret key.
windowsLiveEndpoint	string	Gets or sets the Windows Live endpoint.
wnsCertificate	string	Gets or sets the WNS Certificate.

XiaomiCredential

Object

Description of a NotificationHub XiaomiCredential.

Name	Type	Description
properties	XiaomiCredentialProperties	Description of a NotificationHub XiaomiCredentialProperties.

XiaomiCredentialProperties

Object

Description of a NotificationHub XiaomiCredentialProperties.

Name	Type	Description
appSecret	string	Gets or sets app secret.
endpoint	string	Gets or sets xiaomi service endpoint.

ZoneRedundancyPreference

Enumeration

Namespace SKU name.

Value	Description
Disabled
Enabled