Partager via


Workspace Notification - Get

Gets the details of the Notification specified by its identifier.

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

URI Parameters

Name In Required Type Description
notificationName
path True

NotificationName

Notification Name Identifier.

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

serviceName
path True

string

The name of the API Management service.

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

subscriptionId
path True

string

uuid

The ID of the target subscription. The value must be an UUID.

workspaceId
path True

string

Workspace identifier. Must be unique in the current API Management service instance.

Regex pattern: ^[^*#&+:<>?]+$

api-version
query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

NotificationContract

The response body contains the specified Notification.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementGetWorkspaceNotification

Sample request

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

Sample response

{
  "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"
      ]
    }
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

NotificationContract

Notification details.

NotificationName

Notification Name Identifier.

RecipientsContractProperties

Notification Parameter contract.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

NotificationContract

Notification details.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties.description

string

Description of the Notification.

properties.recipients

RecipientsContractProperties

Recipient Parameter values.

properties.title

string

Title of the Notification.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

NotificationName

Notification Name Identifier.

Name Type Description
AccountClosedPublisher

string

The following email recipients and users will receive email notifications when developer closes his account.

BCC

string

The following recipients will receive blind carbon copies of all emails sent to developers.

NewApplicationNotificationMessage

string

The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.

NewIssuePublisherNotificationMessage

string

The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.

PurchasePublisherNotificationMessage

string

The following email recipients and users will receive email notifications about new API product subscriptions.

QuotaLimitApproachingPublisherNotificationMessage

string

The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.

RequestPublisherNotificationMessage

string

The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.

RecipientsContractProperties

Notification Parameter contract.

Name Type Description
emails

string[]

List of Emails subscribed for the notification.

users

string[]

List of Users subscribed for the notification.