你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Notification - List By Service
列出服务实例中定义的属性的集合。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications?api-version=2022-08-01
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 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
资源组的名称。 此名称不区分大小写。 |
service
|
path | True |
string |
API 管理服务的名称。 Regex pattern: |
subscription
|
path | True |
string |
目标订阅的 ID。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
$skip
|
query |
integer int32 |
要跳过的记录数。 |
|
$top
|
query |
integer int32 |
要返回的记录数。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
指定API 管理服务实例的通知集合。 |
|
Other Status Codes |
描述操作失败原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
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
{
"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": ""
}
定义
名称 | 说明 |
---|---|
Error |
错误字段协定。 |
Error |
错误响应。 |
Notification |
分页通知列表表示形式。 |
Notification |
通知详细信息。 |
Recipients |
通知参数协定。 |
ErrorFieldContract
错误字段协定。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
属性级错误代码。 |
message |
string |
属性级错误的可读表示形式。 |
target |
string |
属性名称。 |
ErrorResponse
错误响应。
名称 | 类型 | 说明 |
---|---|---|
error.code |
string |
服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。 |
error.details |
在发生验证错误的情况下,在请求中发送的无效字段列表。 |
|
error.message |
string |
错误的用户可读表示形式。 |
NotificationCollection
分页通知列表表示形式。
名称 | 类型 | 说明 |
---|---|---|
count |
integer |
所有页面的总记录计数数。 |
nextLink |
string |
下一页链接(如果有)。 |
value |
页面值。 |
NotificationContract
通知详细信息。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
资源的名称 |
properties.description |
string |
通知的说明。 |
properties.recipients |
Recipient 参数值。 |
|
properties.title |
string |
通知的标题。 |
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
RecipientsContractProperties
通知参数协定。
名称 | 类型 | 说明 |
---|---|---|
emails |
string[] |
订阅通知的电子邮件列表。 |
users |
string[] |
订阅通知的用户列表。 |