Notification - Create Or Update

Vytvořte nebo aktualizujte oznámení vydavatele API Management.

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

Parametry identifikátoru URI

Name In Required Type Description
notificationName
path True

Identifikátor názvu oznámení.

resourceGroupName
path True
  • string

Název skupiny prostředků.

serviceName
path True
  • string

Název služby API Management.

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

subscriptionId
path True
  • string

Přihlašovací údaje předplatného, které jednoznačně identifikují Microsoft Azure předplatné. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.

api-version
query True
  • string

Verze rozhraní API, která se má použít s požadavkem klienta.

Hlavička požadavku

Name Required Type Description
If-Match
  • string

ETag of the Entity. Při vytváření entity se nevyžaduje, ale vyžaduje se při aktualizaci entity.

Odpovědi

Name Type Description
200 OK

Oznámení bylo úspěšně aktualizováno.

Other Status Codes

Odpověď na chybu popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

ApiManagementCreateNotification

Sample Request

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

Sample Response

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

Definice

ErrorFieldContract

Kontrakt pole chyby.

ErrorResponse

Odpověď na chybu.

NotificationContract

Podrobnosti o oznámení.

NotificationName

Identifikátor názvu oznámení.

RecipientsContractProperties

Kontrakt parametru oznámení.

ErrorFieldContract

Kontrakt pole chyby.

Name Type Description
code
  • string

Kód chyby na úrovni vlastnosti.

message
  • string

Čitelné znázornění chyby na úrovni vlastností

target
  • string

Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name Type Description
error.code
  • string

Kód chyby definovaný službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.

error.details

Seznamneplatných

error.message
  • string

Čitelné znázornění chyby člověkem

NotificationContract

Podrobnosti o oznámení.

Name Type Description
id
  • string

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Název prostředku

properties.description
  • string

Popis oznámení

properties.recipients

Hodnoty parametru příjemce.

properties.title
  • string

Název oznámení

type
  • string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft. Storage/storageAccounts

NotificationName

Identifikátor názvu oznámení.

Name Type Description
AccountClosedPublisher
  • string

Následující příjemci e-mailu a uživatelé obdrží e-mailová oznámení, když vývojář zavře svůj účet.

BCC
  • string

Následující příjemci dostanou slepé kopie všech e-mailů odeslaných vývojářům.

NewApplicationNotificationMessage
  • string

Následující příjemci e-mailu a uživatelé obdrží e-mailová oznámení při odeslání nových aplikací do galerie aplikací.

NewIssuePublisherNotificationMessage
  • string

Následující příjemci e-mailu a uživatelé obdrží e-mailová oznámení, když se na portálu pro vývojáře odešle nový problém nebo komentář.

PurchasePublisherNotificationMessage
  • string

Následující příjemci e-mailu a uživatelé dostanou e-mailová oznámení o nových předplatných produktů rozhraní API.

QuotaLimitApproachingPublisherNotificationMessage
  • string

Následující příjemci e-mailu a uživatelé obdrží e-mailová oznámení, když se využití předplatného blíží kvótě využití.

RequestPublisherNotificationMessage
  • string

Následující příjemci e-mailu a uživatelé obdrží e-mailová oznámení o žádostech o předplatné pro produkty rozhraní API vyžadující schválení.

RecipientsContractProperties

Kontrakt parametru oznámení.

Name Type Description
emails
  • string[]

Seznam e-mailů přihlášených k odběru oznámení

users
  • string[]

Seznam uživatelů přihlášených k odběru oznámení