Notification - List By Service
Elenca una raccolta di proprietà definite all'interno di un'istanza del servizio.
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
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
service
|
path | True |
string |
Nome del servizio Gestione API. Regex pattern: |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
$skip
|
query |
integer int32 |
Numero di record da ignorare. |
|
$top
|
query |
integer int32 |
Numero di record da restituire. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Raccolta della notifica per l'istanza del servizio Gestione API specificata. |
|
Other Status Codes |
Risposta di errore che descrive perché l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
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": ""
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Contratto campo errore. |
Error |
Risposta errore. |
Notification |
Rappresentazione dell'elenco di notifiche con pagina. |
Notification |
Dettagli di notifica. |
Recipients |
Contratto del parametro di notifica. |
ErrorFieldContract
Contratto campo errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore a livello di proprietà. |
message |
string |
Rappresentazione leggibile dell'errore a livello di proprietà. |
target |
string |
Nome della proprietà. |
ErrorResponse
Risposta errore.
Nome | Tipo | Descrizione |
---|---|---|
error.code |
string |
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta. |
error.details |
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida. |
|
error.message |
string |
Rappresentazione leggibile dell'errore. |
NotificationCollection
Rappresentazione dell'elenco di notifiche con pagina.
Nome | Tipo | Descrizione |
---|---|---|
count |
integer |
Numero totale di record in tutte le pagine. |
nextLink |
string |
Collegamento alla pagina successiva se disponibile. |
value |
Valori di pagina. |
NotificationContract
Dettagli di notifica.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.description |
string |
Descrizione della notifica. |
properties.recipients |
Valori dei parametri destinatario. |
|
properties.title |
string |
Titolo della notifica. |
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
RecipientsContractProperties
Contratto del parametro di notifica.
Nome | Tipo | Descrizione |
---|---|---|
emails |
string[] |
Elenco di messaggi di posta elettronica sottoscritti per la notifica. |
users |
string[] |
Elenco degli utenti sottoscritti per la notifica. |