Workspace Notification - Create Or Update

Service:

API Management

API-versie:

2024-05-01

Maak of werk de uitgevermelding voor API Management bij voor de werkruimte.

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

URI-parameters

Name	In	Vereist	Type	Description
notificationName	path	True	NotificationName	Meldingsnaam-id.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Werkruimte-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match		string	ETag van de entiteit. Niet vereist bij het maken van een entiteit, maar vereist bij het bijwerken van een entiteit.

Antwoorden

Name	Type	Description
200 OK	NotificationContract	De melding is bijgewerkt.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementCreateWorkspaceNotification

Voorbeeldaanvraag

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage?api-version=2024-05-01

Voorbeeldrespons

Statuscode:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage",
  "type": "Microsoft.ApiManagement/service/workspaces/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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com",
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live",
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com"
      ],
      "users": [
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
      ]
    }
  }
}

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
NotificationContract	Meldingsgegevens.
NotificationName	Meldingsnaam-id.
RecipientsContractProperties	Contract voor meldingsparameters.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

NotificationContract

Object

Meldingsgegevens.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.description	string	Beschrijving van de melding.
properties.recipients	RecipientsContractProperties	Parameterwaarden voor geadresseerden.
properties.title	string minLength: 1 maxLength: 1000	Titel van de melding.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

NotificationName

Inventarisatie

Meldingsnaam-id.

Waarde	Description
AccountClosedPublisher	De volgende e-mailontvangers en gebruikers ontvangen e-mailmeldingen wanneer de ontwikkelaar zijn account sluit.
BCC	De volgende ontvangers ontvangen blind carbon kopieën van alle e-mailberichten die naar ontwikkelaars worden verzonden.
NewApplicationNotificationMessage	De volgende e-mailontvangers en gebruikers ontvangen e-mailmeldingen wanneer nieuwe toepassingen worden verzonden naar de toepassingsgalerie.
NewIssuePublisherNotificationMessage	De volgende e-mailontvangers en gebruikers ontvangen e-mailmeldingen wanneer er een nieuw probleem of opmerking wordt verzonden in de ontwikkelaarsportal.
PurchasePublisherNotificationMessage	De volgende e-mailontvangers en gebruikers ontvangen e-mailmeldingen over nieuwe API-productabonnementen.
QuotaLimitApproachingPublisherNotificationMessage	De volgende e-mailontvangers en gebruikers ontvangen e-mailmeldingen wanneer het gebruik van het abonnement dicht bij het gebruiksquotum komt.
RequestPublisherNotificationMessage	De volgende e-mailontvangers en gebruikers ontvangen e-mailmeldingen over abonnementsaanvragen voor API-producten waarvoor goedkeuring is vereist.

RecipientsContractProperties

Object

Contract voor meldingsparameters.

Name	Type	Description
emails	string[]	Lijst met e-mailberichten die zijn geabonneerd voor de melding.
users	string[]	Lijst met gebruikers die zijn geabonneerd op de melding.