Notification Hubs - List

參考

服務:: Notification Hubs

API 版本:: 2023-09-01

清單與命名空間相關聯的通知中樞。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
namespaceName	path	True	string	命名空間名稱 Regex 模式: `^[a-zA-Z][a-zA-Z0-9-]*$`
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string uuid	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string	用於此作業的 API 版本。
$skipToken	query		string	接續令牌。
$top	query		integer int32	頁面大小。

回應

名稱	類型	Description
200 OK	NotificationHubListResult	Success
Other Status Codes	ErrorResponse	具有原因的錯誤碼。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

NotificationHubs_List

範例要求

HTTP

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

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "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"
      }
    }
  ]
}

定義

名稱	Description
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 的描述。
MpnsCredential	NotificationHub MpnsCredential 的描述。
MpnsCredentialProperties	NotificationHub MpnsCredential 的描述。
NotificationHubListResult	List NotificationHub 作業的回應。
NotificationHubProperties	NotificationHub 屬性。
NotificationHubResource	通知中樞資源。
SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule 屬性。
Sku	命名空間的 Sku 描述
SkuName	命名空間 SKU 名稱。
systemData	與建立和上次修改資源相關的元數據。
WnsCredential	NotificationHub WnsCredential 的描述。
WnsCredentialProperties	NotificationHub WnsCredential 的描述。
XiaomiCredential	NotificationHub 一層的 DescriptionmiCredential。
XiaomiCredentialProperties	NotificationHub 一個通知中樞的一個描述CredentialProperties。

AccessRights

定義 AccessRights 的值。

名稱	類型	Description
Listen	string
Manage	string
Send	string

AdmCredential

NotificationHub AdmCredential 的描述。

名稱	類型	Description
properties	AdmCredentialProperties	NotificationHub AdmCredential 的描述。

AdmCredentialProperties

NotificationHub AdmCredential 的描述。

名稱	類型	Description
authTokenUrl	string	取得或設定授權令牌的 URL。
clientId	string	取得或設定用戶端識別碼。
clientSecret	string	取得或設定認證秘密存取金鑰。

ApnsCredential

NotificationHub ApnsCredential 的描述。

名稱	類型	Description
properties	ApnsCredentialProperties	NotificationHub ApnsCredential 的描述。

ApnsCredentialProperties

NotificationHub ApnsCredential 的描述。

名稱	類型	Description
apnsCertificate	string	取得或設定APNS憑證。
appId	string	取得或設定簽發者 (是) 註冊的宣告密鑰，其值為您 10 個字元的小組標識碼，從開發人員帳戶取得
appName	string	取得或設定應用程式的名稱
certificateKey	string	取得或設定憑證金鑰。
endpoint	string	取得或設定這個認證的端點。
keyId	string	取得或設定從開發人員帳戶取得的 10 個字元金鑰標識碼， (兒童) 金鑰
thumbprint	string	取得或設定APNS憑證指紋
token	string	取得或設定透過開發人員帳戶取得的提供者驗證令牌

BaiduCredential

NotificationHub BaiduCredential 的描述。

名稱	類型	Description
properties	BaiduCredentialProperties	NotificationHub BaiduCredential 的描述。

BaiduCredentialProperties

NotificationHub BaiduCredential 的描述。

名稱	類型	Description
baiduApiKey	string	取得或設定百度 API 金鑰。
baiduEndPoint	string	取得或設定百度端點。
baiduSecretKey	string	取得或設定百度秘密金鑰

BrowserCredential

NotificationHub BrowserCredential 的描述。

名稱	類型	Description
properties	BrowserCredentialProperties	NotificationHub BrowserCredential 的描述。

BrowserCredentialProperties

NotificationHub BrowserCredential 的描述。

名稱	類型	Description
subject	string	取得或設定 Web 推送主旨。
vapidPrivateKey	string	取得或設定 VAPID 私鑰。
vapidPublicKey	string	取得或設定 VAPID 公鑰。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

GcmCredential

NotificationHub GcmCredential 的描述。

名稱	類型	Description
properties	GcmCredentialProperties	NotificationHub GcmCredential 的描述。

GcmCredentialProperties

NotificationHub GcmCredential 的描述。

名稱	類型	Description
gcmEndpoint	string	取得或設定 GCM 端點。
googleApiKey	string	取得或設定Google API 金鑰。

MpnsCredential

NotificationHub MpnsCredential 的描述。

名稱	類型	Description
properties	MpnsCredentialProperties	NotificationHub MpnsCredential 的描述。

MpnsCredentialProperties

NotificationHub MpnsCredential 的描述。

名稱	類型	Description
certificateKey	string	取得或設定此認證的憑證金鑰。
mpnsCertificate	string	取得或設定 MPNS 憑證。
thumbprint	string	取得或設定 MPNS 憑證指紋

NotificationHubListResult

List NotificationHub 作業的回應。

名稱	類型	Description
nextLink	string	取得或設定下一組結果的連結。
value	NotificationHubResource[]	取得或設定 List AuthorizationRules 作業的結果。

NotificationHubProperties

NotificationHub 屬性。

名稱	類型	Description
admCredential	AdmCredential	NotificationHub AdmCredential 的描述。
apnsCredential	ApnsCredential	NotificationHub ApnsCredential 的描述。
authorizationRules	SharedAccessAuthorizationRuleProperties[]	取得或設定所建立 NotificationHub 的 AuthorizationRules
baiduCredential	BaiduCredential	NotificationHub BaiduCredential 的描述。
browserCredential	BrowserCredential	NotificationHub BrowserCredential 的描述。
dailyMaxActiveDevices	integer
gcmCredential	GcmCredential	NotificationHub GcmCredential 的描述。
mpnsCredential	MpnsCredential	NotificationHub MpnsCredential 的描述。
name	string	取得或設定 NotificationHub 名稱。
registrationTtl	string	取得或設定所建立 NotificationHub 的 RegistrationTtl
wnsCredential	WnsCredential	NotificationHub WnsCredential 的描述。
xiaomiCredential	XiaomiCredential	NotificationHub 一層的 DescriptionmiCredential。

NotificationHubResource

通知中樞資源。

名稱	類型	Description
id	string	資源的完整資源識別碼。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	資源所在的地理位置
name	string	資源的名稱
properties	NotificationHubProperties	NotificationHub 屬性。
sku	Sku	命名空間的 Sku 描述
systemData	systemData	Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。
tags	object	資源標籤。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

SharedAccessAuthorizationRuleProperties

SharedAccessAuthorizationRule 屬性。

名稱	類型	Description
claimType	string	取得描述宣告類型的字串
claimValue	string	取得描述宣告值的字串
createdTime	string	取得此規則的建立時間
keyName	string	取得描述授權規則的字串。
modifiedTime	string	取得此規則的上次修改時間
primaryKey	string	取得base64編碼的256位主要金鑰，用於簽署和驗證SAS令牌。
revision	integer	取得規則的修訂編號
rights	AccessRights[]	取得或設定與規則相關聯的許可權。
secondaryKey	string	取得base64編碼的256位主要金鑰，用於簽署和驗證SAS令牌。

Sku

命名空間的 Sku 描述

名稱	類型	Description
capacity	integer	取得或設定資源的容量
family	string	取得或設定 Sku 系列
name	SkuName	命名空間 SKU 名稱。
size	string	取得或設定 Sku 大小
tier	string	取得或設定特定 SKU 的階層

SkuName

命名空間 SKU 名稱。

名稱	類型	Description
Basic	string
Free	string
Standard	string

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

WnsCredential

NotificationHub WnsCredential 的描述。

名稱	類型	Description
properties	WnsCredentialProperties	NotificationHub WnsCredential 的描述。

WnsCredentialProperties