Namespaces - Get

Служба:

Notification Hubs

Версия API:

2023-09-01

Возвращает заданное пространство имен.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
namespaceName	path	True	string	Имя пространства имен Шаблон регулярного выражения: ^[a-zA-Z][a-zA-Z0-9-]*$
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId	path	True	string uuid	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	NamespaceResource	Успешное завершение
Other Status Codes	ErrorResponse	Код ошибки с причиной.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Namespaces_Get

Образец запроса

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

Пример ответа

Код состояния:

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"
  }
}

Определения

Имя	Описание
AccessRights	Определяет значения для AccessRights.
AdmCredential	Описание NotificationHub AdmCredential.
AdmCredentialProperties	Описание NotificationHub AdmCredential.
ApnsCredential	Описание объекта NotificationHub ApnsCredential.
ApnsCredentialProperties	Описание объекта NotificationHub ApnsCredential.
BaiduCredential	Описание NotificationHub BaiduCredential.
BaiduCredentialProperties	Описание NotificationHub BaiduCredential.
BrowserCredential	Описание NotificationHub BrowserCredential.
BrowserCredentialProperties	Описание NotificationHub BrowserCredential.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
GcmCredential	Описание NotificationHub GcmCredential.
GcmCredentialProperties	Описание NotificationHub GcmCredential.
IpRule	Правило авторизации сети, которое фильтрует трафик на основе IP-адреса.
MpnsCredential	Описание NotificationHub MpnsCredential.
MpnsCredentialProperties	Описание NotificationHub MpnsCredential.
NamespaceProperties	Представляет свойства пространства имен.
NamespaceResource	Ресурс пространства имен Центров уведомлений.
NamespaceStatus	Состояние пространства имен.
NamespaceType	Определяет значения для NamespaceType.
NetworkAcls	Коллекция правил авторизации сети.
OperationProvisioningState	Определяет значения для OperationProvisioningState.
PnsCredentials	Коллекция учетных данных PNS центра уведомлений или пространства имен центра уведомлений.
PrivateEndpointConnectionProperties	Свойства подключения к частной конечной точке.
PrivateEndpointConnectionProvisioningState	Состояние подключения к частной конечной точке.
PrivateEndpointConnectionResource	Представляет ресурс ARM подключения к частной конечной точке — подресурс пространства имен Центров уведомлений.
PrivateLinkConnectionStatus	Состояние подключения Приватный канал.
PublicInternetAuthorizationRule	Правило авторизации сети по умолчанию (общедоступный Интернет), которое содержит права, если другие правила сети не соответствуют.
PublicNetworkAccess	Тип доступа к общедоступной сети.
RemotePrivateEndpointConnection	Представляет частную конечную точку, подключенную к пространству имен Центров уведомлений с помощью подключения к частной конечной точке.
RemotePrivateLinkServiceConnectionState	Состояние подключения службы Приватный канал.
ReplicationRegion	Разрешенный регион репликации
Sku	Описание номера SKU для пространства имен
SkuName	Имя SKU пространства имен.
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
WnsCredential	Описание WnsCredential для NotificationHub.
WnsCredentialProperties	Описание WnsCredential для NotificationHub.
XiaomiCredential	Описание NotificationHub XiaomiCredential.
XiaomiCredentialProperties	Описание Объекта NotificationHub Для XiaomiCredentialProperties.
ZoneRedundancyPreference	Имя SKU пространства имен.

AccessRights

Определяет значения для AccessRights.

Имя	Тип	Описание
Listen	string
Manage	string
Send	string

AdmCredential

Описание NotificationHub AdmCredential.

Имя	Тип	Описание
properties	AdmCredentialProperties	Описание NotificationHub AdmCredential.

AdmCredentialProperties

Описание NotificationHub AdmCredential.

Имя	Тип	Описание
authTokenUrl	string	Возвращает или задает URL-адрес маркера авторизации.
clientId	string	Возвращает или задает идентификатор клиента.
clientSecret	string	Возвращает или задает ключ доступа секрета учетных данных.

ApnsCredential

Описание объекта NotificationHub ApnsCredential.

Имя	Тип	Описание
properties	ApnsCredentialProperties	Описание объекта NotificationHub ApnsCredential.

ApnsCredentialProperties

Описание объекта NotificationHub ApnsCredential.

Имя	Тип	Описание
apnsCertificate	string	Возвращает или задает сертификат APNS.
appId	string	Возвращает или задает зарегистрированный ключ утверждения издателя (ISS), значением которого является 10-значный идентификатор команды, полученный из учетной записи разработчика.
appName	string	Возвращает или задает имя приложения.
certificateKey	string	Возвращает или задает ключ сертификата.
endpoint	string	Возвращает или задает конечную точку этих учетных данных.
keyId	string	Возвращает или задает 10-значный идентификатор ключа (kid), полученный из учетной записи разработчика.
thumbprint	string	Возвращает или задает отпечаток сертификата APNS.
token	string	Возвращает или задает маркер проверки подлинности поставщика, полученный через учетную запись разработчика.

BaiduCredential

Описание NotificationHub BaiduCredential.

Имя	Тип	Описание
properties	BaiduCredentialProperties	Описание NotificationHub BaiduCredential.

BaiduCredentialProperties

Описание NotificationHub BaiduCredential.

Имя	Тип	Описание
baiduApiKey	string	Возвращает или задает ключ API baidu.
baiduEndPoint	string	Возвращает или задает конечную точку baidu.
baiduSecretKey	string	Возвращает или задает секретный ключ baidu.

BrowserCredential

Описание NotificationHub BrowserCredential.

Имя	Тип	Описание
properties	BrowserCredentialProperties	Описание NotificationHub BrowserCredential.

BrowserCredentialProperties

Описание NotificationHub BrowserCredential.

Имя	Тип	Описание
subject	string	Возвращает или задает тему веб-отправки.
vapidPrivateKey	string	Возвращает или задает закрытый ключ VAPID.
vapidPublicKey	string	Возвращает или задает открытый ключ VAPID.

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект error.

GcmCredential

Описание NotificationHub GcmCredential.

Имя	Тип	Описание
properties	GcmCredentialProperties	Описание NotificationHub GcmCredential.

GcmCredentialProperties

Описание NotificationHub GcmCredential.

Имя	Тип	Описание
gcmEndpoint	string	Возвращает или задает конечную точку GCM.
googleApiKey	string	Возвращает или задает ключ API Google.

IpRule

Правило авторизации сети, которое фильтрует трафик на основе IP-адреса.

Имя	Тип	Описание
ipMask	string	Маска IP-адреса.
rights	AccessRights[]	Список прав доступа.

MpnsCredential

Описание NotificationHub MpnsCredential.

Имя	Тип	Описание
properties	MpnsCredentialProperties	Описание NotificationHub MpnsCredential.

MpnsCredentialProperties

Описание NotificationHub MpnsCredential.

Имя	Тип	Описание
certificateKey	string	Возвращает или задает ключ сертификата для этих учетных данных.
mpnsCertificate	string	Возвращает или задает сертификат MPNS.
thumbprint	string	Возвращает или задает отпечаток сертификата MPNS.

NamespaceProperties

Представляет свойства пространства имен.

Имя	Тип	Default value	Описание
createdAt	string		Время создания пространства имен.
critical	boolean		Возвращает или задает значение, указывающее, задано ли для пространства имен значение Критическое.
dataCenter	string		Не рекомендуется.
enabled	boolean		Возвращает или задает значение, указывающее, включено ли пространство имен в данный момент.
metricId	string		Идентификатор метрик Azure Insights.
name	string		Имя пространства имен Центров уведомлений. Это неизменяемое свойство, которое автоматически устанавливается службой при создании пространства имен.
namespaceType	NamespaceType		Определяет значения для NamespaceType.
networkAcls	NetworkAcls		Коллекция правил авторизации сети.
pnsCredentials	PnsCredentials		Коллекция учетных данных PNS центра уведомлений или пространства имен центра уведомлений.
privateEndpointConnections	PrivateEndpointConnectionResource[]		Connections частной конечной точки для пространства имен
provisioningState	OperationProvisioningState		Определяет значения для OperationProvisioningState.
publicNetworkAccess	PublicNetworkAccess	Enabled	Тип доступа к общедоступной сети.
region	string		Регион. Для параметра всегда задано то же значение, что и Namespace.Location, поэтому мы не рекомендуем использовать это свойство.
replicationRegion	ReplicationRegion		Разрешенный регион репликации
scaleUnit	string		Возвращает или задает scaleUnit, где создается пространство имен.
serviceBusEndpoint	string		Возвращает или задает конечную точку, используемую для выполнения операций NotificationHub.
status	NamespaceStatus		Состояние пространства имен.
subscriptionId	string		Идентификатор подписки на пространство имен.
updatedAt	string		Время обновления пространства имен.
zoneRedundancy	ZoneRedundancyPreference	Disabled	Имя SKU пространства имен.

NamespaceResource

Ресурс пространства имен Центров уведомлений.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса.
properties	NamespaceProperties	Представляет свойства пространства имен.
sku	Sku	Описание номера SKU для пространства имен
systemData	systemData	Azure Resource Manager метаданные, содержащие сведения createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

NamespaceStatus

Состояние пространства имен.

Имя	Тип	Описание
Created	string
Creating	string
Deleting	string
Suspended	string

NamespaceType

Определяет значения для NamespaceType.

Имя	Тип	Описание
Messaging	string
NotificationHub	string

NetworkAcls

Коллекция правил авторизации сети.

Имя	Тип	Описание
ipRules	IpRule[]	Список правил IP-адресов.
publicNetworkRule	PublicInternetAuthorizationRule	Правило авторизации сети по умолчанию (общедоступный Интернет), которое содержит права, если другие правила сети не соответствуют.

OperationProvisioningState

Определяет значения для OperationProvisioningState.

Имя	Тип	Описание
Canceled	string
Disabled	string
Failed	string
InProgress	string
Pending	string
Succeeded	string
Unknown	string

PnsCredentials

Коллекция учетных данных PNS центра уведомлений или пространства имен центра уведомлений.

Имя	Тип	Описание
admCredential	AdmCredential	Описание NotificationHub AdmCredential.
apnsCredential	ApnsCredential	Описание объекта NotificationHub ApnsCredential.
baiduCredential	BaiduCredential	Описание NotificationHub BaiduCredential.
browserCredential	BrowserCredential	Описание NotificationHub BrowserCredential.
gcmCredential	GcmCredential	Описание NotificationHub GcmCredential.
mpnsCredential	MpnsCredential	Описание NotificationHub MpnsCredential.
wnsCredential	WnsCredential	Описание WnsCredential для NotificationHub.
xiaomiCredential	XiaomiCredential	Описание NotificationHub XiaomiCredential.

PrivateEndpointConnectionProperties

Свойства подключения к частной конечной точке.

Имя	Тип	Описание
groupIds	string[]	Список идентификаторов групп. Для Центров уведомлений он всегда содержит один элемент пространства имен.
privateEndpoint	RemotePrivateEndpointConnection	Представляет частную конечную точку, подключенную к пространству имен Центров уведомлений с помощью подключения к частной конечной точке.
privateLinkServiceConnectionState	RemotePrivateLinkServiceConnectionState	Состояние подключения службы Приватный канал.
provisioningState	PrivateEndpointConnectionProvisioningState	Состояние подключения к частной конечной точке.

PrivateEndpointConnectionProvisioningState

Состояние подключения к частной конечной точке.

Имя	Тип	Описание
Creating	string
Deleted	string
Deleting	string
DeletingByProxy	string
Succeeded	string
Unknown	string
Updating	string
UpdatingByProxy	string

PrivateEndpointConnectionResource

Представляет ресурс ARM подключения к частной конечной точке — подресурс пространства имен Центров уведомлений.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса.
properties	PrivateEndpointConnectionProperties	Свойства подключения к частной конечной точке.
systemData	systemData	Azure Resource Manager метаданные, содержащие сведения createdBy и modifiedBy.
type	string	Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

PrivateLinkConnectionStatus

Состояние подключения Приватный канал.

Имя	Тип	Описание
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicInternetAuthorizationRule

Правило авторизации сети по умолчанию (общедоступный Интернет), которое содержит права, если другие правила сети не соответствуют.

Имя	Тип	Описание
rights	AccessRights[]	Список прав доступа.

PublicNetworkAccess

Тип доступа к общедоступной сети.

Имя	Тип	Описание
Disabled	string
Enabled	string

RemotePrivateEndpointConnection

Представляет частную конечную точку, подключенную к пространству имен Центров уведомлений с помощью подключения к частной конечной точке.

Имя	Тип	Описание
id	string	Идентификатор ресурса ARM частной конечной точки. Он может принадлежать к другой подписке и группе ресурсов, чем к пространству имен Центров уведомлений.

RemotePrivateLinkServiceConnectionState

Состояние подключения службы Приватный канал.

Имя	Тип	Описание
actionsRequired	string	Понятное для человека описание необходимых действий.
description	string	Понятное описание.
status	PrivateLinkConnectionStatus	Состояние подключения Приватный канал.

ReplicationRegion

Разрешенный регион репликации

Имя	Тип	Описание
AustraliaEast	string
BrazilSouth	string
Default	string
None	string
NorthEurope	string
SouthAfricaNorth	string
SouthEastAsia	string
WestUs2	string

Sku

Описание номера SKU для пространства имен

Имя	Тип	Описание
capacity	integer	Возвращает или задает емкость ресурса.
family	string	Возвращает или задает семейство SKU
name	SkuName	Имя SKU пространства имен.
size	string	Возвращает или задает размер SKU.
tier	string	Возвращает или задает уровень определенного номера SKU.

SkuName

Имя SKU пространства имен.

Имя	Тип	Описание
Basic	string
Free	string
Standard	string

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое последним изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, которое последним изменял ресурс.

WnsCredential

Описание WnsCredential для NotificationHub.

Имя	Тип	Описание
properties	WnsCredentialProperties	Описание WnsCredential для NotificationHub.

WnsCredentialProperties

Описание WnsCredential для NotificationHub.

Имя	Тип	Описание
certificateKey	string	Определяет или задает ключ сертификата WNS.
packageSid	string	Возвращает или задает идентификатор пакета для этих учетных данных.
secretKey	string	Возвращает или задает секретный ключ.
windowsLiveEndpoint	string	Возвращает или задает конечную точку Windows Live.
wnsCertificate	string	Возвращает или задает сертификат WNS.

XiaomiCredential

Описание NotificationHub XiaomiCredential.

Имя	Тип	Описание
properties	XiaomiCredentialProperties	Описание Объекта NotificationHub Для XiaomiCredentialProperties.

XiaomiCredentialProperties

Описание Объекта NotificationHub Для XiaomiCredentialProperties.

Имя	Тип	Описание
appSecret	string	Возвращает или задает секрет приложения.
endpoint	string	Возвращает или задает конечную точку службы xiaomi.

ZoneRedundancyPreference

Имя SKU пространства имен.

Имя	Тип	Описание
Disabled	string
Enabled	string