Notification - Create Or Update

  • Referência
Service:
API Management
API Version:
2022-08-01

Criar ou Atualizar Gestão de API notificação do publicador.

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

Parâmetros do URI

Name Em Necessário Tipo Description
notificationName
 path True

NotificationName

Identificador de Nome de Notificação.
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
serviceName
 path True

string

O nome do serviço Gestão de API.

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

string

O ID da subscrição de destino.
api-version
 query True

string

A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name Necessário Tipo Description
If-Match

string

ETag da Entidade. Não é necessário ao criar uma entidade, mas é necessário ao atualizar uma entidade.

Respostas

Name Tipo Description
200 OK

NotificationContract

A notificação foi atualizada com êxito.
Other Status Codes

ErrorResponse

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

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

Definições

Name Description
ErrorFieldContract

Contrato de Campo de Erro.
ErrorResponse

Resposta do Erro.
NotificationContract

Detalhes da notificação.
NotificationName

Identificador de Nome de Notificação.
RecipientsContractProperties

Contrato do Parâmetro de Notificação.

ErrorFieldContract

Contrato de Campo de Erro.

Name Tipo Description
code

string

Código de erro de nível de propriedade.
message

string

Representação legível por humanos do erro ao nível da propriedade.
target

string

Nome da propriedade.

ErrorResponse

Resposta do Erro.

Name Tipo Description
error.code

string

Código de erro definido pelo serviço. Este código serve como um subestado para o código de erro HTTP especificado na resposta.
error.details

ErrorFieldContract[]

A lista de campos inválidos enviados no pedido, em caso de erro de validação.
error.message

string

Representação legível por humanos do erro.

NotificationContract

Detalhes da notificação.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

O nome do recurso
properties.description

string

Descrição da Notificação.
properties.recipients

RecipientsContractProperties

Valores do Parâmetro do Destinatário.
properties.title

string

Título da Notificação.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

NotificationName

Identificador de Nome de Notificação.

Name Tipo Description
AccountClosedPublisher

string

Os seguintes destinatários e utilizadores de e-mail receberão notificações por e-mail quando o programador fechar a conta.
BCC

string

Os seguintes destinatários receberão cópias ocultas de carbono de todos os e-mails enviados aos programadores.
NewApplicationNotificationMessage

string

Os seguintes destinatários e utilizadores de e-mail receberão notificações por e-mail quando forem submetidas novas aplicações para a galeria de aplicações.
NewIssuePublisherNotificationMessage

string

Os seguintes destinatários e utilizadores de e-mail receberão notificações por e-mail quando um novo problema ou comentário for submetido no portal do programador.
PurchasePublisherNotificationMessage

string

Os seguintes destinatários e utilizadores de e-mail receberão notificações por e-mail sobre novas subscrições de produtos da API.
QuotaLimitApproachingPublisherNotificationMessage

string

Os seguintes destinatários e utilizadores de e-mail receberão notificações por e-mail quando a utilização da subscrição estiver próxima da quota de utilização.
RequestPublisherNotificationMessage

string

Os seguintes destinatários e utilizadores de e-mail receberão notificações por e-mail sobre pedidos de subscrição para produtos API que requerem aprovação.

RecipientsContractProperties

Contrato do Parâmetro de Notificação.

Name Tipo Description
emails

string[]

Lista de E-mails subscritos para a notificação.
users

string[]

Lista de Utilizadores subscritos para a notificação.