Notification - Create Or Update

Criar ou atualizar Gestão de API notificação de editor.

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

Parâmetros do URI

Name In Required Type Description
notificationName
path True

Identificador de nome de notificação.

resourceGroupName
path True
  • string

O nome do grupo de recursos.

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

Credenciais de subscrição que identificam exclusivamente Microsoft Azure subscrição. O ID de subscrição faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão da API a ser usada com o pedido do cliente.

Cabeçalho do Pedido

Name Required Type Description
If-Match
  • string

ETag da Entidade. Não é necessário na criação de uma entidade, mas é necessário na atualização de uma entidade.

Respostas

Name Type Description
200 OK

A notificação foi atualizada com sucesso.

Other Status Codes

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

Segurança

azure_auth

Azure Ative Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation personificar 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=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"
      ]
    }
  }
}

Definições

ErrorFieldContract

Contrato de Campo de Erro.

ErrorResponse

Resposta a erros.

NotificationContract

Detalhes da notificação.

NotificationName

Identificador de nome de notificação.

RecipientsContractProperties

Contrato de parâmetro de notificação.

ErrorFieldContract

Contrato de Campo de Erro.

Name Type Description
code
  • string

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

message
  • string

Representação legível pelo homem de erro de nível de propriedade.

target
  • string

Nome da propriedade.

ErrorResponse

Resposta a erros.

Name Type Description
error.code
  • string

Código de erro definido pelo serviço. Este código serve como sub-estado para o código de erro HTTP especificado na resposta.

error.details

A lista de campos inválidos envia a pedido, em caso de erro de validação.

error.message
  • string

Representação legível pelo homem do erro.

NotificationContract

Detalhes da notificação.

Name Type Description
id
  • string

ID de recursos totalmente qualificado para o recurso. Ex - /subscrições/{subscriçãoD}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

O nome do recurso

properties.description
  • string

Descrição da Notificação.

properties.recipients

Valores do parâmetro do destinatário.

properties.title
  • string

Título da Notificação.

type
  • string

O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft." Armazenamento/armazenamentoCotalhos"

NotificationName

Identificador de nome de notificação.

Name Type Description
AccountClosedPublisher
  • string

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

BCC
  • string

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

NewApplicationNotificationMessage
  • string

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

NewIssuePublisherNotificationMessage
  • string

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

PurchasePublisherNotificationMessage
  • string

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

QuotaLimitApproachingPublisherNotificationMessage
  • string

Os seguintes destinatários de e-mail e utilizadores receberão notificações de e-mail quando o uso da subscrição se aproximar da quota de utilização.

RequestPublisherNotificationMessage
  • string

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

RecipientsContractProperties

Contrato de parâmetro de notificação.

Name Type Description
emails
  • string[]

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

users
  • string[]

Lista de Utilizadores inscritos para a notificação.