Compartilhar via

Notification Recipient Email - Create Or Update

  • Referência
Serviço:
API Management
Versão da API:
2024-05-01

Adiciona o endereço de email à lista de Destinatários da Notificação.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
email
 path True

string

Identificador de email.
notificationName
 path True

NotificationName

Identificador de nome de notificação.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

O nome do serviço de Gerenciamento de API.
subscriptionId
 path True

string (uuid)

A ID da assinatura de destino. O valor deve ser uma UUID.
api-version
 query True

string

minLength: 1

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

Respostas

Nome Tipo Description
200 OK

RecipientEmailContract

O Email do Destinatário já faz parte da lista de notificação.
201 Created

RecipientEmailContract

O Email do Destinatário foi adicionado com êxito à lista de notificações.
Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementCreateNotificationRecipientEmail

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com",
  "type": "Microsoft.ApiManagement/service/notifications/recipientEmails",
  "name": "foobar@live.com",
  "properties": {
    "email": "foobar@live.com"
  }
}
Código de status:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com",
  "type": "Microsoft.ApiManagement/service/notifications/recipientEmails",
  "name": "foobar@live.com",
  "properties": {
    "email": "foobar@live.com"
  }
}

Definições

Nome Description
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
NotificationName

Identificador de nome de notificação.
RecipientEmailContract

Detalhes do email do destinatário.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

NotificationName

Enumeração

Identificador de nome de notificação.

Valor Description
AccountClosedPublisher

Os destinatários e usuários de email a seguir receberão notificações por email quando o desenvolvedor fechar sua conta.
BCC

Os destinatários a seguir receberão cópias de carbono cegas de todos os emails enviados aos desenvolvedores.
NewApplicationNotificationMessage

Os destinatários e usuários de email a seguir receberão notificações por email quando novos aplicativos forem enviados para a galeria de aplicativos.
NewIssuePublisherNotificationMessage

Os destinatários de email e os usuários a seguir receberão notificações por email quando um novo problema ou comentário for enviado no portal do desenvolvedor.
PurchasePublisherNotificationMessage

Os destinatários e usuários de email a seguir receberão notificações por email sobre novas assinaturas de produtos de API.
QuotaLimitApproachingPublisherNotificationMessage

Os destinatários e usuários de email a seguir receberão notificações por email quando o uso da assinatura chegar perto da cota de uso.
RequestPublisherNotificationMessage

Os destinatários e usuários de email a seguir receberão notificações por email sobre solicitações de assinatura para produtos de API que exigem aprovação.

RecipientEmailContract

Objeto

Detalhes do email do destinatário.

Nome Tipo Description
id

string

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

string

O nome do recurso
properties.email

string

Email do Usuário inscrito na notificação.
type

string

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