Notification - Create Or Update

  • Reference
Service:
API Management
API Version:
2022-08-01

Oznámení vydavatele o vytvoření nebo aktualizaci API Management

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
notificationName
 path True

NotificationName

Identifikátor názvu oznámení.
resourceGroupName
 path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
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

ID cílového předplatného.
api-version
 query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name Vyžadováno Typ Description
If-Match

string

Značka ETag entity. Nevyžaduje se při vytváření entity, ale vyžaduje se při aktualizaci entity.

Odpovědi

Name Typ Description
200 OK

NotificationContract

Oznámení se úspěšně aktualizovalo.
Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory 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=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"
      ]
    }
  }
}

Definice

Name Description
ErrorFieldContract

Chyba Kontrakt pole.
ErrorResponse

Odpověď na chybu.
NotificationContract

Podrobnosti oznámení.
NotificationName

Identifikátor názvu oznámení.
RecipientsContractProperties

Kontrakt parametru oznámení.

ErrorFieldContract

Chyba Kontrakt pole.

Name Typ 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 Typ 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

ErrorFieldContract[]

Seznam neplatných polí se odešle v žádosti v případě chyby ověření.
error.message

string

Znázornění chyby čitelné pro člověka

NotificationContract

Podrobnosti oznámení.

Name Typ Description
id

string

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

string

Název prostředku
properties.description

string

Popis oznámení.
properties.recipients

RecipientsContractProperties

Hodnoty parametrů 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 Typ 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 obdrží 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í, když se do galerie aplikací odesílají nové aplikace.
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é budou dostávat 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 přiblíží kvótě využití.
RequestPublisherNotificationMessage

string

Následující příjemci e-mailu a uživatelé budou dostávat e-mailová oznámení o žádostech o odběr produktů ROZHRANÍ API vyžadujících schválení.

RecipientsContractProperties

Kontrakt parametru oznámení.

Name Typ Description
emails

string[]

Seznam e-mailů s přihlášením k odběru oznámení
users

string[]

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