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 參數

名稱	位於	必要	類型	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 版本。

回應

名稱	類型	Description
200 OK	NamespaceResource	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	模擬您的用戶帳戶

範例

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

定義

名稱	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 的描述。
IpRule	根據IP位址篩選流量的網路授權規則。
MpnsCredential	NotificationHub MpnsCredential 的描述。
MpnsCredentialProperties	NotificationHub MpnsCredential 的描述。
NamespaceProperties	表示命名空間屬性。
NamespaceResource	通知中樞命名空間資源。
NamespaceStatus	命名空間狀態。
NamespaceType	定義 NamespaceType 的值。
NetworkAcls	網路授權規則的集合。
OperationProvisioningState	定義 OperationProvisioningState 的值。
PnsCredentials	通知中樞或通知中樞命名空間 PNS 認證的集合。
PrivateEndpointConnectionProperties	私人端點連線屬性。
PrivateEndpointConnectionProvisioningState	私人端點連線的狀態。
PrivateEndpointConnectionResource	代表私人端點連線 ARM 資源 - 通知中樞命名空間的子資源。
PrivateLinkConnectionStatus	Private Link 連線的狀態。
PublicInternetAuthorizationRule	默認 (公用因特網) 網路授權規則，如果沒有其他網路規則相符，則包含許可權。
PublicNetworkAccess	公用網路存取的類型。
RemotePrivateEndpointConnection	表示使用私人端點連線連接到通知中樞命名空間的私人端點。
RemotePrivateLinkServiceConnectionState	Private Link 服務連線的狀態。
ReplicationRegion	允許的復寫區域
Sku	命名空間的 SKU 描述
SkuName	命名空間 SKU 名稱。
systemData	與建立和上次修改資源相關的元數據。
WnsCredential	NotificationHub WnsCredential 的描述。
WnsCredentialProperties	NotificationHub WnsCredential 的描述。
XiaomiCredential	NotificationHub ExplorermiCredential 的描述。
XiaomiCredentialProperties	NotificationHub ExplorermiCredentialProperties 的描述。
ZoneRedundancyPreference	命名空間 SKU 名稱。

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	error 物件。

GcmCredential

NotificationHub GcmCredential 的描述。

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

GcmCredentialProperties

NotificationHub GcmCredential 的描述。

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

IpRule

根據IP位址篩選流量的網路授權規則。

名稱	類型	Description
ipMask	string	IP 遮罩。
rights	AccessRights[]	訪問許可權清單。

MpnsCredential

NotificationHub MpnsCredential 的描述。

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

MpnsCredentialProperties

NotificationHub MpnsCredential 的描述。

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

NamespaceProperties

表示命名空間屬性。

名稱	類型	預設值	Description
createdAt	string		建立命名空間的時間。
critical	boolean		取得或設定命名空間是否設定為 Critical。
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

通知中樞命名空間資源。

名稱	類型	Description
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

命名空間狀態。

名稱	類型	Description
Created	string
Creating	string
Deleting	string
Suspended	string

NamespaceType

定義 NamespaceType 的值。

名稱	類型	Description
Messaging	string
NotificationHub	string

NetworkAcls

網路授權規則的集合。

名稱	類型	Description
ipRules	IpRule[]	IP 規則的清單。
publicNetworkRule	PublicInternetAuthorizationRule	默認 (公用因特網) 網路授權規則，如果沒有其他網路規則相符，則包含許可權。

OperationProvisioningState

定義 OperationProvisioningState 的值。

名稱	類型	Description
Canceled	string
Disabled	string
Failed	string
InProgress	string
Pending	string
Succeeded	string
Unknown	string

PnsCredentials

通知中樞或通知中樞命名空間 PNS 認證的集合。

名稱	類型	Description
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	NotificationHub WnsCredential 的描述。
xiaomiCredential	XiaomiCredential	NotificationHub ExplorermiCredential 的描述。

PrivateEndpointConnectionProperties

私人端點連線屬性。

名稱	類型	Description
groupIds	string[]	群組標識碼的清單。 對於通知中樞，它一律包含單一 “namespace” 元素。
privateEndpoint	RemotePrivateEndpointConnection	表示使用私人端點連線連接到通知中樞命名空間的私人端點。
privateLinkServiceConnectionState	RemotePrivateLinkServiceConnectionState	Private Link 服務連線的狀態。
provisioningState	PrivateEndpointConnectionProvisioningState	私人端點連線的狀態。

PrivateEndpointConnectionProvisioningState

私人端點連線的狀態。

名稱	類型	Description
Creating	string
Deleted	string
Deleting	string
DeletingByProxy	string
Succeeded	string
Unknown	string
Updating	string
UpdatingByProxy	string

PrivateEndpointConnectionResource

代表私人端點連線 ARM 資源 - 通知中樞命名空間的子資源。

名稱	類型	Description
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

Private Link 連線的狀態。

名稱	類型	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicInternetAuthorizationRule

默認 (公用因特網) 網路授權規則，如果沒有其他網路規則相符，則包含許可權。

名稱	類型	Description
rights	AccessRights[]	訪問許可權清單。

PublicNetworkAccess

公用網路存取的類型。

名稱	類型	Description
Disabled	string
Enabled	string

RemotePrivateEndpointConnection

表示使用私人端點連線連接到通知中樞命名空間的私人端點。

名稱	類型	Description
id	string	私人端點的 ARM 資源識別碼。 這可能屬於與通知中樞命名空間不同的訂用帳戶和資源群組。

RemotePrivateLinkServiceConnectionState

Private Link 服務連線的狀態。

名稱	類型	Description
actionsRequired	string	必要動作的易記描述。
description	string	人類易記的描述。
status	PrivateLinkConnectionStatus	Private Link 連線的狀態。

ReplicationRegion

允許的復寫區域

名稱	類型	Description
AustraliaEast	string
BrazilSouth	string
Default	string
None	string
NorthEurope	string
SouthAfricaNorth	string
SouthEastAsia	string
WestUs2	string

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

NotificationHub WnsCredential 的描述。

名稱	類型	Description
certificateKey	string	Ges 或設定 WNS 憑證金鑰。
packageSid	string	取得或設定此認證的套件識別碼。
secretKey	string	取得或設定秘密金鑰。
windowsLiveEndpoint	string	取得或設定 Windows Live 端點。
wnsCertificate	string	取得或設定 WNS 憑證。

XiaomiCredential

NotificationHub ExplorermiCredential 的描述。

名稱	類型	Description
properties	XiaomiCredentialProperties	NotificationHub ExplorermiCredentialProperties 的描述。

XiaomiCredentialProperties

NotificationHub ExplorermiCredentialProperties 的描述。

名稱	類型	Description
appSecret	string	取得或設定應用程式秘密。
endpoint	string	取得或設定程式碼服務端點。

ZoneRedundancyPreference

命名空間 SKU 名稱。

名稱	類型	Description
Disabled	string
Enabled	string