Share via

Notification Hubs - Update

  • リファレンス
Service:
Notification Hubs
API Version:
2023-09-01

名前空間の NotificationHub にパッチを適用します。

PATCH 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

名前空間名

Regex pattern: ^[a-zA-Z][a-zA-Z0-9-]*$
notificationHubName
 path True

string

通知ハブの名前

Regex pattern: ^[a-zA-Z][a-zA-Z0-9-./_]*$
resourceGroupName
 path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。
subscriptionId
 path True

string

uuid

ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version
 query True

string

この操作に使用する API バージョン。

要求本文

名前 型 説明
properties

NotificationHubProperties

NotificationHub プロパティ。
sku

Sku

名前空間の Sku の説明
tags

object

応答

名前 型 説明
200 OK

NotificationHubResource

Success
Other Status Codes

ErrorResponse

理由を含むエラー コード。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

例

NotificationHubs_Update

Sample Request

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

{
  "properties": {
    "registrationTtl": "10675199.02:48:05.4775807",
    "gcmCredential": {
      "properties": {
        "gcmEndpoint": "https://fcm.googleapis.com/fcm/send",
        "googleApiKey": "###################################"
      }
    }
  }
}

Sample Response

Status code:
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 の説明。
NotificationHubPatchParameters

NamespaceResource の Patch パラメーター。
NotificationHubProperties

NotificationHub プロパティ。
NotificationHubResource

Notification Hub リソース。
SharedAccessAuthorizationRuleProperties

SharedAccessAuthorizationRule プロパティ。
Sku

名前空間の Sku の説明
SkuName

名前空間 SKU 名。
systemData

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

NotificationHub WnsCredential の説明。
WnsCredentialProperties

NotificationHub WnsCredential の説明。
XiaomiCredential

NotificationHub XiaomiCredential の説明。
XiaomiCredentialProperties

NotificationHub XiaomiCredentialProperties の説明。

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

開発者アカウントから取得した 10 文字のチーム ID を値とする発行者 (iss) 登録済みクレーム キーを取得または設定します。
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

baidu Api Key を取得または設定します。
baiduEndPoint

string

baidu Endpoint を取得または設定します。
baiduSecretKey

string

baidu シークレット キーを取得または設定します

BrowserCredential

NotificationHub BrowserCredential の説明。

名前 型 説明
properties

BrowserCredentialProperties

NotificationHub BrowserCredential の説明。

BrowserCredentialProperties

NotificationHub BrowserCredential の説明。

名前 型 説明
subject

string

Web プッシュサブジェクトを取得または設定します。
vapidPrivateKey

string

VAPID 秘密キーを取得または設定します。
vapidPublicKey

string

VAPID 公開キーを取得または設定します。

createdByType

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

名前 型 説明
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

Google API キーを取得または設定します。

MpnsCredential

NotificationHub MpnsCredential の説明。

名前 型 説明
properties

MpnsCredentialProperties

NotificationHub MpnsCredential の説明。

MpnsCredentialProperties

NotificationHub MpnsCredential の説明。

名前 型 説明
certificateKey

string

この資格情報の証明書キーを取得または設定します。
mpnsCertificate

string

MPNS 証明書を取得または設定します。
thumbprint

string

MPNS 証明書の拇印を取得または設定します

NotificationHubPatchParameters

NamespaceResource の Patch パラメーター。

名前 型 説明
properties

NotificationHubProperties

NotificationHub プロパティ。
sku

Sku

名前空間の Sku の説明
tags

object

NotificationHubProperties

NotificationHub プロパティ。

名前 型 説明
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 XiaomiCredential の説明。

NotificationHubResource

Notification Hub リソース。

名前 型 説明
id

string

リソースの完全修飾リソース 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

SharedAccessAuthorizationRule プロパティ。

名前 型 説明
claimType

string

要求の種類を説明する文字列を取得します
claimValue

string

要求値を記述する文字列を取得します
createdTime

string

このルールの作成時刻を取得します
keyName

string

承認規則を記述する文字列を取得します。
modifiedTime

string

このルールの最終変更時刻を取得します
primaryKey

string

SAS トークンに署名して検証するための base64 でエンコードされた 256 ビットの主キーを取得します。
revision

integer

ルールのリビジョン番号を取得します
rights

AccessRights[]

ルールに関連付けられている権限を取得または設定します。
secondaryKey

string

SAS トークンに署名して検証するための base64 でエンコードされた 256 ビットの主キーを取得します。

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

リソースを作成した ID。
createdByType

createdByType

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

string

リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。

WnsCredential

NotificationHub WnsCredential の説明。

名前 型 説明
properties

WnsCredentialProperties

NotificationHub WnsCredential の説明。

WnsCredentialProperties

NotificationHub WnsCredential の説明。

名前 型 説明
certificateKey

string

WNS 証明書キーを設定します。
packageSid

string

この資格情報のパッケージ ID を取得または設定します。
secretKey

string

秘密キーを取得または設定します。
windowsLiveEndpoint

string

Windows Live エンドポイントを取得または設定します。
wnsCertificate

string

WNS 証明書を取得または設定します。

XiaomiCredential

NotificationHub XiaomiCredential の説明。

名前 型 説明
properties

XiaomiCredentialProperties

NotificationHub XiaomiCredentialProperties の説明。

XiaomiCredentialProperties

NotificationHub XiaomiCredentialProperties の説明。

名前 型 説明
appSecret

string

アプリ シークレットを取得または設定します。
endpoint

string

xiaomi サービス エンドポイントを取得または設定します。