Notification - List By Service
Listet eine Auflistung der in einer Dienstinstanz definierten Eigenschaften auf
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-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
service
|
path | True |
string |
Der Name des API Management-Diensts. RegEx-Muster: |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
$skip
|
query |
integer int32 |
Die Anzahl der zu überspringenden Datensätze. |
|
$top
|
query |
integer int32 |
Die Anzahl der zurückzugebenden Datensätze. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Eine Auflistung der Benachrichtigung für den angegebenen API Management-Dienst instance. |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Flow.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
ApiManagementListNotifications
Beispielanforderung
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications?api-version=2022-08-01
Beispiel für eine Antwort
{
"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": ""
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Fehler Feldvertrag. |
Error |
Fehlerantwort. |
Notification |
Darstellung der Auslagerungsbenachrichtigungsliste. |
Notification |
Benachrichtigungsdetails. |
Recipients |
Benachrichtigungsparametervertrag. |
ErrorFieldContract
Fehler Feldvertrag.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode auf Eigenschaftsebene. |
message |
string |
Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene. |
target |
string |
Der Eigenschaftsname. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error.code |
string |
Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode. |
error.details |
Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers. |
|
error.message |
string |
Lesbare Darstellung des Fehlers. |
NotificationCollection
Darstellung der Auslagerungsbenachrichtigungsliste.
Name | Typ | Beschreibung |
---|---|---|
count |
integer |
Gesamtzahl der Datensätze auf allen Seiten. |
nextLink |
string |
Link zur nächsten Seite, falls vorhanden. |
value |
Seitenwerte. |
NotificationContract
Benachrichtigungsdetails.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Der Name der Ressource |
properties.description |
string |
Beschreibung der Benachrichtigung. |
properties.recipients |
Empfängerparameterwerte. |
|
properties.title |
string |
Titel der Benachrichtigung. |
type |
string |
Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
RecipientsContractProperties
Benachrichtigungsparametervertrag.
Name | Typ | Beschreibung |
---|---|---|
emails |
string[] |
Liste der E-Mails, die für die Benachrichtigung abonniert wurden. |
users |
string[] |
Liste der Benutzer, die die Benachrichtigung abonniert haben. |