Notification Recipient Email - Create Or Update

サービス:

API Management

API バージョン:

2024-05-01

通知の受信者の一覧に電子メール アドレスを追加します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}?api-version=2024-05-01

URI パラメーター

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

応答

名前	型	説明
200 OK	RecipientEmailContract	受信者の電子メールは既に通知リストの一部です。
201 Created	RecipientEmailContract	受信者の電子メールが通知リストに正常に追加されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

ApiManagementCreateNotificationRecipientEmail

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com?api-version=2024-05-01

応答のサンプル

状態コード:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com",
  "type": "Microsoft.ApiManagement/service/notifications/recipientEmails",
  "name": "foobar@live.com",
  "properties": {
    "email": "foobar@live.com"
  }
}

状態コード:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com",
  "type": "Microsoft.ApiManagement/service/notifications/recipientEmails",
  "name": "foobar@live.com",
  "properties": {
    "email": "foobar@live.com"
  }
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
NotificationName	通知名識別子。
RecipientEmailContract	受信者の電子メールの詳細。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

NotificationName

列挙

通知名識別子。

値	説明
AccountClosedPublisher	次の電子メール受信者とユーザーは、開発者が自分のアカウントを閉じると電子メール通知を受け取ります。
BCC	次の受信者は、開発者に送信されたすべての電子メールのブラインド カーボン コピーを受け取ります。
NewApplicationNotificationMessage	次の電子メール受信者とユーザーは、新しいアプリケーションがアプリケーション ギャラリーに送信されたときに電子メール通知を受け取ります。
NewIssuePublisherNotificationMessage	開発者ポータルで新しい問題またはコメントが送信されると、次の電子メール受信者とユーザーに電子メール通知が送信されます。
PurchasePublisherNotificationMessage	次のメール受信者とユーザーは、新しい API 製品サブスクリプションに関する電子メール通知を受け取ります。
QuotaLimitApproachingPublisherNotificationMessage	サブスクリプションの使用量が使用量クォータに近づくと、次の電子メール受信者とユーザーは電子メール通知を受け取ります。
RequestPublisherNotificationMessage	次の電子メール受信者とユーザーは、承認を必要とする API 製品のサブスクリプション要求に関する電子メール通知を受け取ります。

RecipientEmailContract

Object

受信者の電子メールの詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.email	string	通知をサブスクライブしたユーザー電子メール。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"