Notification Hubs - Get
Возвращает центр уведомлений.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}?api-version=2023-09-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
namespace
|
path | True |
string |
Имя пространства имен Regex pattern: |
notification
|
path | True |
string |
Имя концентратора уведомлений Regex pattern: |
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
subscription
|
path | True |
string uuid |
Идентификатор целевой подписки. Значение должно быть UUID. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Успешное завершение |
|
Other Status Codes |
Код ошибки с причиной. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
NotificationHubs_Get
Sample Request
GET https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/nh-sdk-hub?api-version=2023-09-01
Sample Response
{
"location": "East US",
"properties": {
"name": "test",
"registrationTtl": "10675199.02:48:05.4775807",
"dailyMaxActiveDevices": 0
},
"id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test",
"name": "test",
"type": "Microsoft.NotificationHubs/namespaces/notificationHubs",
"tags": {
"hubTag1": "hubTagValue1",
"hubTag2": "hubTagValue2"
}
}
Определения
Имя | Описание |
---|---|
Access |
Определяет значения для AccessRights. |
Adm |
Описание NotificationHub AdmCredential. |
Adm |
Описание NotificationHub AdmCredential. |
Apns |
Описание объекта NotificationHub ApnsCredential. |
Apns |
Описание объекта NotificationHub ApnsCredential. |
Baidu |
Описание NotificationHub BaiduCredential. |
Baidu |
Описание NotificationHub BaiduCredential. |
Browser |
Описание NotificationHub BrowserCredential. |
Browser |
Описание NotificationHub BrowserCredential. |
created |
Тип удостоверения, создавшего ресурс. |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Сообщение об ошибке |
Gcm |
Описание NotificationHub GcmCredential. |
Gcm |
Описание NotificationHub GcmCredential. |
Mpns |
Описание NotificationHub MpnsCredential. |
Mpns |
Описание NotificationHub MpnsCredential. |
Notification |
Свойства NotificationHub. |
Notification |
Ресурс центра уведомлений. |
Shared |
Свойства SharedAccessAuthorizationRule. |
Sku |
Описание номера SKU для пространства имен |
Sku |
Имя SKU пространства имен. |
system |
Метаданные, относящиеся к созданию и последнему изменению ресурса. |
Wns |
Описание WnsCredential для NotificationHub. |
Wns |
Описание WnsCredential для NotificationHub. |
Xiaomi |
Описание NotificationHub XiaomiCredential. |
Xiaomi |
Описание Объекта NotificationHub Для XiaomiCredentialProperties. |
AccessRights
Определяет значения для AccessRights.
Имя | Тип | Описание |
---|---|---|
Listen |
string |
|
Manage |
string |
|
Send |
string |
AdmCredential
Описание NotificationHub AdmCredential.
Имя | Тип | Описание |
---|---|---|
properties |
Описание NotificationHub AdmCredential. |
AdmCredentialProperties
Описание NotificationHub AdmCredential.
Имя | Тип | Описание |
---|---|---|
authTokenUrl |
string |
Возвращает или задает URL-адрес маркера авторизации. |
clientId |
string |
Возвращает или задает идентификатор клиента. |
clientSecret |
string |
Возвращает или задает ключ доступа секрета учетных данных. |
ApnsCredential
Описание объекта NotificationHub ApnsCredential.
Имя | Тип | Описание |
---|---|---|
properties |
Описание объекта 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 |
Описание NotificationHub BaiduCredential. |
BaiduCredentialProperties
Описание NotificationHub BaiduCredential.
Имя | Тип | Описание |
---|---|---|
baiduApiKey |
string |
Возвращает или задает ключ API baidu. |
baiduEndPoint |
string |
Возвращает или задает конечную точку baidu. |
baiduSecretKey |
string |
Возвращает или задает секретный ключ baidu. |
BrowserCredential
Описание NotificationHub BrowserCredential.
Имя | Тип | Описание |
---|---|---|
properties |
Описание 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 |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
error |
Объект error. |
GcmCredential
Описание NotificationHub GcmCredential.
Имя | Тип | Описание |
---|---|---|
properties |
Описание NotificationHub GcmCredential. |
GcmCredentialProperties
Описание NotificationHub GcmCredential.
Имя | Тип | Описание |
---|---|---|
gcmEndpoint |
string |
Возвращает или задает конечную точку GCM. |
googleApiKey |
string |
Возвращает или задает ключ API Google. |
MpnsCredential
Описание NotificationHub MpnsCredential.
Имя | Тип | Описание |
---|---|---|
properties |
Описание NotificationHub MpnsCredential. |
MpnsCredentialProperties
Описание NotificationHub MpnsCredential.
Имя | Тип | Описание |
---|---|---|
certificateKey |
string |
Возвращает или задает ключ сертификата для этих учетных данных. |
mpnsCertificate |
string |
Возвращает или задает сертификат MPNS. |
thumbprint |
string |
Возвращает или задает отпечаток сертификата MPNS. |
NotificationHubProperties
Свойства NotificationHub.
Имя | Тип | Описание |
---|---|---|
admCredential |
Описание NotificationHub AdmCredential. |
|
apnsCredential |
Описание объекта NotificationHub ApnsCredential. |
|
authorizationRules |
Возвращает или задает значение AuthorizationRules созданного центра уведомлений. |
|
baiduCredential |
Описание NotificationHub BaiduCredential. |
|
browserCredential |
Описание NotificationHub BrowserCredential. |
|
dailyMaxActiveDevices |
integer |
|
gcmCredential |
Описание NotificationHub GcmCredential. |
|
mpnsCredential |
Описание NotificationHub MpnsCredential. |
|
name |
string |
Возвращает или задает имя NotificationHub. |
registrationTtl |
string |
Возвращает или задает значение RegistrationTtl созданного notificationHub. |
wnsCredential |
Описание WnsCredential для NotificationHub. |
|
xiaomiCredential |
Описание NotificationHub XiaomiCredential. |
NotificationHubResource
Ресурс центра уведомлений.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
location |
string |
Географическое расположение, в котором находится ресурс |
name |
string |
Имя ресурса. |
properties |
Свойства NotificationHub. |
|
sku |
Описание номера SKU для пространства имен |
|
systemData |
Azure Resource Manager метаданные, содержащие сведения createdBy и modifiedBy. |
|
tags |
object |
Теги ресурсов. |
type |
string |
Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts. |
SharedAccessAuthorizationRuleProperties
Свойства SharedAccessAuthorizationRule.
Имя | Тип | Описание |
---|---|---|
claimType |
string |
Возвращает строку, описывающую тип утверждения. |
claimValue |
string |
Возвращает строку, описывающую значение утверждения. |
createdTime |
string |
Возвращает время создания для этого правила. |
keyName |
string |
Возвращает строку, описывающую правило авторизации. |
modifiedTime |
string |
Возвращает время последнего изменения для этого правила. |
primaryKey |
string |
Возвращает 256-разрядный первичный ключ в кодировке Base64 для подписывания и проверки маркера SAS. |
revision |
integer |
Возвращает номер редакции для правила. |
rights |
Возвращает или задает права, связанные с правилом. |
|
secondaryKey |
string |
Возвращает 256-разрядный первичный ключ в кодировке Base64 для подписывания и проверки маркера SAS. |
Sku
Описание номера SKU для пространства имен
Имя | Тип | Описание |
---|---|---|
capacity |
integer |
Возвращает или задает емкость ресурса. |
family |
string |
Возвращает или задает семейство SKU |
name |
Имя SKU пространства имен. |
|
size |
string |
Возвращает или задает размер SKU. |
tier |
string |
Возвращает или задает уровень определенного номера SKU. |
SkuName
Имя SKU пространства имен.
Имя | Тип | Описание |
---|---|---|
Basic |
string |
|
Free |
string |
|
Standard |
string |
systemData
Метаданные, относящиеся к созданию и последнему изменению ресурса.
Имя | Тип | Описание |
---|---|---|
createdAt |
string |
Метка времени создания ресурса (UTC). |
createdBy |
string |
Удостоверение, создающее ресурс. |
createdByType |
Тип удостоверения, создавшего ресурс. |
|
lastModifiedAt |
string |
Метка времени последнего изменения ресурса (UTC) |
lastModifiedBy |
string |
Удостоверение, которое последним изменял ресурс. |
lastModifiedByType |
Тип удостоверения, которое последним изменял ресурс. |
WnsCredential
Описание WnsCredential для NotificationHub.
Имя | Тип | Описание |
---|---|---|
properties |
Описание WnsCredential для NotificationHub. |
WnsCredentialProperties
Описание WnsCredential для NotificationHub.
Имя | Тип | Описание |
---|---|---|
certificateKey |
string |
Определяет или задает ключ сертификата WNS. |
packageSid |
string |
Возвращает или задает идентификатор пакета для этих учетных данных. |
secretKey |
string |
Возвращает или задает секретный ключ. |
windowsLiveEndpoint |
string |
Возвращает или задает конечную точку Windows Live. |
wnsCertificate |
string |
Возвращает или задает сертификат WNS. |
XiaomiCredential
Описание NotificationHub XiaomiCredential.
Имя | Тип | Описание |
---|---|---|
properties |
Описание Объекта NotificationHub Для XiaomiCredentialProperties. |
XiaomiCredentialProperties
Описание Объекта NotificationHub Для XiaomiCredentialProperties.
Имя | Тип | Описание |
---|---|---|
appSecret |
string |
Возвращает или задает секрет приложения. |
endpoint |
string |
Возвращает или задает конечную точку службы xiaomi. |