Workspace Notification - Get

リファレンス

サービス:: API Management

API バージョン:: 2024-05-01

識別子で指定された通知の詳細を取得します。

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

URI パラメーター

名前	/	必須	型	説明
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 である必要があります。
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	ワークスペース識別子。現在の API Management サービスインスタンスで一意である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	NotificationContract	応答本文には、指定された通知が含まれています。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

ApiManagementGetWorkspaceNotification

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage?api-version=2024-05-01

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage",
  "type": "Microsoft.ApiManagement/service/workspaces/notifications",
  "name": "RequestPublisherNotificationMessage",
  "properties": {
    "title": "Subscription requests (requiring approval)",
    "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.",
    "recipients": {
      "emails": [
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com",
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live",
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com"
      ],
      "users": [
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
      ]
    }
  }
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
NotificationContract	通知の詳細。
NotificationName	通知名識別子。
RecipientsContractProperties	通知パラメーターコントラクト。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

NotificationContract

Object

通知の詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.description	string	通知の説明。
properties.recipients	RecipientsContractProperties	受信者パラメーターの値。
properties.title	string minLength: 1 maxLength: 1000	通知のタイトル。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

NotificationName

列挙

通知名識別子。

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

RecipientsContractProperties

Object

通知パラメーターコントラクト。

名前	型	説明
emails	string[]	通知をサブスクライブした電子メールの一覧。
users	string[]	通知をサブスクライブしたユーザーの一覧。

次の方法で共有

Workspace Notification - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementGetWorkspaceNotification

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NotificationContract

NotificationName

RecipientsContractProperties

その他のリソース