Notification - List By Service

  • リファレンス
Service:
API Management
API Version:
2022-08-01

サービス インスタンス内で定義されているプロパティのコレクションを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications?$top={$top}&$skip={$skip}&api-version=2022-08-01

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

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

string

API Management サービスの名前。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

ターゲット サブスクリプションの ID。
api-version
 query True

string

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

integer

int32

スキップするレコードの数。
$top
 query

integer

int32

返されるレコードの数。

応答

名前 型 説明
200 OK

NotificationCollection

指定したAPI Management サービス インスタンスの Notification のコレクション。
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 ユーザー アカウントの借用

例

ApiManagementListNotifications

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage",
      "type": "Microsoft.ApiManagement/service/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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com",
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live",
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com"
          ],
          "users": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
          ]
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/PurchasePublisherNotificationMessage",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "PurchasePublisherNotificationMessage",
      "properties": {
        "title": "New subscriptions",
        "description": "The following email recipients and users will receive email notifications about new API product subscriptions.",
        "recipients": {
          "emails": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com"
          ],
          "users": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
          ]
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewApplicationNotificationMessage",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "NewApplicationNotificationMessage",
      "properties": {
        "title": "Application gallery requests",
        "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.",
        "recipients": {
          "emails": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com"
          ],
          "users": []
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/BCC",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "BCC",
      "properties": {
        "title": "BCC",
        "description": "The following recipients will receive blind carbon copies of all emails sent to developers.",
        "recipients": {
          "emails": [],
          "users": []
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewIssuePublisherNotificationMessage",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "NewIssuePublisherNotificationMessage",
      "properties": {
        "title": "New issue or comment",
        "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.",
        "recipients": {
          "emails": [],
          "users": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
          ]
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/AccountClosedPublisher",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "AccountClosedPublisher",
      "properties": {
        "title": "Close account message",
        "description": "The following email recipients and users will receive email notifications when developer closes his account",
        "recipients": {
          "emails": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com"
          ],
          "users": []
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/QuotaLimitApproachingPublisherNotificationMessage",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "QuotaLimitApproachingPublisherNotificationMessage",
      "properties": {
        "title": "Approaching subscription quota limit",
        "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.",
        "recipients": {
          "emails": [],
          "users": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
          ]
        }
      }
    }
  ],
  "count": 7,
  "nextLink": ""
}

定義

名前 説明
ErrorFieldContract

エラー フィールド コントラクト。
ErrorResponse

エラー応答。
NotificationCollection

[Paged Notification list representation]\(ページ通知リストの表現\)
NotificationContract

通知の詳細。
RecipientsContractProperties

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

ErrorFieldContract

エラー フィールド コントラクト。

名前 型 説明
code

string

プロパティ レベルのエラー コード。
message

string

プロパティ レベルエラーの人間が判読できる表現。
target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 型 説明
error.code

string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details

ErrorFieldContract[]

検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message

string

人が判読できるエラーの表現。

NotificationCollection

[Paged Notification list representation]\(ページ通知リストの表現\)

名前 型 説明
count

integer

すべてのページの合計レコード数。
nextLink

string

次のページリンク (存在する場合)。
value

NotificationContract[]

ページ値。

NotificationContract

通知の詳細。

名前 型 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

リソースの名前
properties.description

string

通知の説明。
properties.recipients

RecipientsContractProperties

Recipient Parameter の値。
properties.title

string

通知のタイトル。
type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

RecipientsContractProperties

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

名前 型 説明
emails

string[]

通知をサブスクライブした電子メールの一覧。
users

string[]

通知をサブスクライブしたユーザーの一覧。