你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 管理服务的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	工作区标识符。 当前 API 管理服务实例中必须是唯一的。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	NotificationContract	响应正文包含指定的通知。
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 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。 Ex - /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[]	订阅通知的用户列表。