Notification - Create Or Update

  • Odwołanie
Service:
API Management
API Version:
2022-08-01

Tworzenie lub aktualizowanie powiadomienia wydawcy API Management.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}?api-version=2022-08-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
notificationName
 path True

NotificationName

Identyfikator nazwy powiadomienia.
resourceGroupName
 path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
serviceName
 path True

string

Nazwa usługi API Management.

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

string

Identyfikator subskrypcji docelowej.
api-version
 query True

string

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa Wymagane Typ Opis
If-Match

string

ETag jednostki. Nie jest wymagane podczas tworzenia jednostki, ale wymagane podczas aktualizowania jednostki.

Odpowiedzi

Nazwa Typ Opis
200 OK

NotificationContract

Powiadomienie zostało pomyślnie zaktualizowane.
Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementCreateNotification

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "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/recipientEmails/contoso@live.com",
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar!live",
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar@live.com"
      ],
      "users": [
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
      ]
    }
  }
}

Definicje

Nazwa Opis
ErrorFieldContract

Błąd Kontrakt pola.
ErrorResponse

Odpowiedź na błąd.
NotificationContract

Szczegóły powiadomienia.
NotificationName

Identyfikator nazwy powiadomienia.
RecipientsContractProperties

Kontrakt parametru powiadomienia.

ErrorFieldContract

Błąd Kontrakt pola.

Nazwa Typ Opis
code

string

Kod błędu poziomu właściwości.
message

string

Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.
target

string

Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Nazwa Typ Opis
error.code

string

Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.
error.details

ErrorFieldContract[]

Lista nieprawidłowych pól jest wysyłana w żądaniu w przypadku błędu walidacji.
error.message

string

Czytelna dla człowieka reprezentacja błędu.

NotificationContract

Szczegóły powiadomienia.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nazwa zasobu
properties.description

string

Opis powiadomienia.
properties.recipients

RecipientsContractProperties

Wartości parametru odbiorcy.
properties.title

string

Tytuł powiadomienia.
type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

NotificationName

Identyfikator nazwy powiadomienia.

Nazwa Typ Opis
AccountClosedPublisher

string

Następujący adresaci e-mail i użytkownicy otrzymają powiadomienia e-mail po zamknięciu konta przez dewelopera.
BCC

string

Następujący adresaci otrzymają ślepe kopie emisji dwutlenku węgla wszystkich wiadomości e-mail wysyłanych do deweloperów.
NewApplicationNotificationMessage

string

Następujący adresaci wiadomości e-mail i użytkownicy otrzymają powiadomienia e-mail, gdy nowe aplikacje zostaną przesłane do galerii aplikacji.
NewIssuePublisherNotificationMessage

string

Następujący adresaci wiadomości e-mail i użytkownicy otrzymają powiadomienia e-mail, gdy nowy problem lub komentarz zostanie przesłany w portalu deweloperów.
PurchasePublisherNotificationMessage

string

Następujący adresaci wiadomości e-mail i użytkownicy otrzymają powiadomienia e-mail dotyczące nowych subskrypcji produktów interfejsu API.
QuotaLimitApproachingPublisherNotificationMessage

string

Następujący adresaci wiadomości e-mail i użytkownicy otrzymają powiadomienia e-mail, gdy użycie subskrypcji zbliża się do limitu przydziału użycia.
RequestPublisherNotificationMessage

string

Następujący adresaci wiadomości e-mail i użytkownicy otrzymają powiadomienia e-mail dotyczące żądań subskrypcji dla produktów interfejsu API wymagających zatwierdzenia.

RecipientsContractProperties

Kontrakt parametru powiadomienia.

Nazwa Typ Opis
emails

string[]

Lista wiadomości e-mail subskrybowanych dla powiadomienia.
users

string[]

Lista użytkowników subskrybowanych dla powiadomienia.