Notification Hubs - Get

サービス:

Notification Hubs

API バージョン:

2023-09-01

通知ハブを取得します。

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

URI パラメーター

名前	/	必須	型	説明
namespaceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]*$	名前空間名
notificationHubName	path	True	string minLength: 1 maxLength: 265 pattern: ^[a-zA-Z][a-zA-Z0-9-./_]*$	通知ハブの名前
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	NotificationHubResource	成功
Other Status Codes	ErrorResponse	理由付きのエラー コード。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

NotificationHubs_Get

要求のサンプル

HTTP

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

応答のサンプル

状態コード:

200

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

定義

名前	説明
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	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GcmCredential	NotificationHub GcmCredential の説明。
GcmCredentialProperties	NotificationHub GcmCredential の説明。
MpnsCredential	NotificationHub MpnsCredential の説明。
MpnsCredentialProperties	NotificationHub MpnsCredential の説明。
NotificationHubProperties	NotificationHub プロパティ。
NotificationHubResource	Notification Hub リソース。
SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule プロパティ。
Sku	名前空間の SKU の説明
SkuName	名前空間 SKU 名。
systemData	リソースの作成と最後の変更に関連するメタデータ。
WnsCredential	NotificationHub WnsCredential の説明。
WnsCredentialProperties	NotificationHub WnsCredential の説明。
XiaomiCredential	NotificationHubXiaomiCredential の説明。
XiaomiCredentialProperties	NotificationHubXiaomiCredentialProperties の説明。

AccessRights

列挙

AccessRights の値を定義します。

値	説明
Listen
Manage
Send

AdmCredential

Object

NotificationHub AdmCredential の説明。

名前	型	説明
properties	AdmCredentialProperties	NotificationHub AdmCredential の説明。

AdmCredentialProperties

Object

NotificationHub AdmCredential の説明。

名前	型	説明
authTokenUrl	string minLength: 1	承認トークンの URL を取得または設定します。
clientId	string minLength: 1	クライアント識別子を取得または設定します。
clientSecret	string minLength: 1	資格情報シークレット アクセス キーを取得または設定します。

ApnsCredential

Object

NotificationHub ApnsCredential の説明。

名前	型	説明
properties	ApnsCredentialProperties	NotificationHub ApnsCredential の説明。

ApnsCredentialProperties

Object

NotificationHub ApnsCredential の説明。

名前	型	説明
apnsCertificate	string	APNS 証明書を取得または設定します。
appId	string	開発者アカウントから取得した、10 文字のチーム ID を値とする発行者 (iss) 登録済み要求キーを取得または設定します。
appName	string	アプリケーションの名前を取得または設定します。
certificateKey	string	証明書キーを取得または設定します。
endpoint	string minLength: 1	この資格情報のエンドポイントを取得または設定します。
keyId	string	開発者アカウントから取得した 10 文字のキー識別子 (kid) キーを取得または設定します。
thumbprint	string	APNS 証明書の拇印を取得または設定します。
token	string	開発者アカウントを使用して取得したプロバイダー認証トークンを取得または設定します。

BaiduCredential

Object

NotificationHub BaiduCredential の説明。

名前	型	説明
properties	BaiduCredentialProperties	NotificationHub BaiduCredential の説明。

BaiduCredentialProperties

Object

NotificationHub BaiduCredential の説明。

名前	型	説明
baiduApiKey	string minLength: 1	baidu Api キーを取得または設定します。
baiduEndPoint	string minLength: 1	baidu Endpoint を取得または設定します。
baiduSecretKey	string minLength: 1	baidu 秘密鍵を取得または設定します。

BrowserCredential

Object

NotificationHub BrowserCredential の説明。

名前	型	説明
properties	BrowserCredentialProperties	NotificationHub BrowserCredential の説明。

BrowserCredentialProperties

Object

NotificationHub BrowserCredential の説明。

名前	型	説明
subject	string minLength: 1	Web プッシュの件名を取得または設定します。
vapidPrivateKey	string minLength: 1	VAPID 秘密キーを取得または設定します。
vapidPublicKey	string minLength: 1	VAPID 公開キーを取得または設定します。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

GcmCredential

Object

NotificationHub GcmCredential の説明。

名前	型	説明
properties	GcmCredentialProperties	NotificationHub GcmCredential の説明。

GcmCredentialProperties

Object

NotificationHub GcmCredential の説明。

名前	型	説明
gcmEndpoint	string	GCM エンドポイントを取得または設定します。
googleApiKey	string minLength: 1	Google API キーを取得または設定します。

MpnsCredential

Object

NotificationHub MpnsCredential の説明。

名前	型	説明
properties	MpnsCredentialProperties	NotificationHub MpnsCredential の説明。

MpnsCredentialProperties

Object

NotificationHub MpnsCredential の説明。

名前	型	説明
certificateKey	string minLength: 1	この資格情報の証明書キーを取得または設定します。
mpnsCertificate	string minLength: 1	MPNS 証明書を取得または設定します。
thumbprint	string minLength: 1	MPNS 証明書の拇印を取得または設定します。

NotificationHubProperties

Object

NotificationHub プロパティ。

名前	型	説明
admCredential	AdmCredential	NotificationHub AdmCredential の説明。
apnsCredential	ApnsCredential	NotificationHub ApnsCredential の説明。
authorizationRules	SharedAccessAuthorizationRuleProperties[]	作成された NotificationHub の AuthorizationRules を取得または設定します。
baiduCredential	BaiduCredential	NotificationHub BaiduCredential の説明。
browserCredential	BrowserCredential	NotificationHub BrowserCredential の説明。
dailyMaxActiveDevices	integer (int64)
gcmCredential	GcmCredential	NotificationHub GcmCredential の説明。
mpnsCredential	MpnsCredential	NotificationHub MpnsCredential の説明。
name	string	NotificationHub 名を取得または設定します。
registrationTtl	string	作成された NotificationHub の RegistrationTtl を取得または設定します。
wnsCredential	WnsCredential	NotificationHub WnsCredential の説明。
xiaomiCredential	XiaomiCredential	NotificationHubXiaomiCredential の説明。

NotificationHubResource

Object

Notification Hub リソース。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	リソースが存在する地理的な場所
name	string	リソースの名前
properties	NotificationHubProperties	NotificationHub プロパティ。
sku	Sku	名前空間の SKU の説明
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソース タグ。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SharedAccessAuthorizationRuleProperties

Object

SharedAccessAuthorizationRule プロパティ。

名前	型	説明
claimType	string	要求の種類を記述する文字列を取得します。
claimValue	string	要求値を記述する文字列を取得します。
createdTime	string (date-time)	このルールの作成時刻を取得します。
keyName	string	承認規則を記述する文字列を取得します。
modifiedTime	string (date-time)	この規則の最終変更時刻を取得します。
primaryKey	string	SAS トークンに署名して検証するための base64 でエンコードされた 256 ビットの主キーを取得します。
revision	integer (int32)	ルールのリビジョン番号を取得します。
rights	AccessRights[]	規則に関連付けられている権限を取得または設定します。
secondaryKey	string	SAS トークンに署名して検証するための base64 でエンコードされた 256 ビットの主キーを取得します。

Sku

Object

名前空間の SKU の説明

名前	型	説明
capacity	integer (int32)	リソースの容量を取得または設定します。
family	string	Sku ファミリを取得または設定します。
name	SkuName	名前空間 SKU 名。
size	string	SKU サイズを取得または設定します。
tier	string	特定の SKU のレベルを取得または設定します。

SkuName

列挙

名前空間 SKU 名。

値	説明
Basic
Free
Standard

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

WnsCredential

Object

NotificationHub WnsCredential の説明。

名前	型	説明
properties	WnsCredentialProperties	NotificationHub WnsCredential の説明。

WnsCredentialProperties

Object

NotificationHub WnsCredential の説明。

名前	型	説明
certificateKey	string	WNS 証明書キーを設定します。
packageSid	string	この資格情報のパッケージ ID を取得または設定します。
secretKey	string	秘密鍵を取得または設定します。
windowsLiveEndpoint	string	Windows Live エンドポイントを取得または設定します。
wnsCertificate	string	WNS 証明書を取得または設定します。

XiaomiCredential

Object

NotificationHubXiaomiCredential の説明。

名前	型	説明
properties	XiaomiCredentialProperties	NotificationHubXiaomiCredentialProperties の説明。

XiaomiCredentialProperties

Object

NotificationHubXiaomiCredentialProperties の説明。

名前	型	説明
appSecret	string	アプリ シークレットを取得または設定します。
endpoint	string	xiaomi サービス エンドポイントを取得または設定します。