Notification - Create Or Update

API Management 게시자 알림을 만들거나 업데이트합니다.

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

URI 매개 변수

Name In Required Type Description
notificationName
path True

알림 이름 식별자입니다.

resourceGroupName
path True
  • string

리소스 그룹의 이름.

serviceName
path True
  • string

API Management 서비스의 이름입니다.

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

subscriptionId
path True
  • string

Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.

api-version
query True
  • string

클라이언트 요청과 함께 사용할 API의 버전입니다.

요청 헤더

Name Required Type Description
If-Match
  • string

엔터티의 ETag입니다. 엔터티를 만들 때는 필요하지 않지만 엔터티를 업데이트할 때 필요합니다.

응답

Name Type Description
200 OK

알림이 성공적으로 업데이트되었습니다.

Other Status Codes

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

OAuth2 Flow Azure Active Directory.

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

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

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

정의

ErrorFieldContract

오류 필드 계약입니다.

ErrorResponse

오류 응답입니다.

NotificationContract

알림 세부 정보입니다.

NotificationName

알림 이름 식별자입니다.

RecipientsContractProperties

알림 매개 변수 계약입니다.

ErrorFieldContract

오류 필드 계약입니다.

Name Type Description
code
  • string

속성 수준 오류 코드입니다.

message
  • string

사람이 읽을 수 있는 속성 수준 오류 표현입니다.

target
  • string

속성 이름입니다.

ErrorResponse

오류 응답입니다.

Name Type Description
error.code
  • string

서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.

error.details

유효성 검사 오류가 발생한 경우 요청에 잘못된 필드가 전송되는 목록입니다.

error.message
  • string

사람이 읽을 수 있는 오류 표현입니다.

NotificationContract

알림 세부 정보입니다.

Name Type Description
id
  • string

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

리소스의 이름입니다.

properties.description
  • string

알림에 대한 설명입니다.

properties.recipients

Recipient 매개 변수 값입니다.

properties.title
  • string

알림의 제목입니다.

type
  • string

리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft. Storage/storageAccounts"

NotificationName

알림 이름 식별자입니다.

Name Type Description
AccountClosedPublisher
  • string

개발자가 자신의 계정을 닫을 때 다음 전자 메일 받는 사람 및 사용자가 전자 메일 알림을 받게 됩니다.

BCC
  • string

다음 받는 사람은 개발자에게 보낸 모든 전자 메일의 블라인드 카본 복사본을 받게 됩니다.

NewApplicationNotificationMessage
  • string

다음 전자 메일 받는 사람 및 사용자는 새 애플리케이션이 애플리케이션 갤러리에 제출될 때 전자 메일 알림을 받게 됩니다.

NewIssuePublisherNotificationMessage
  • string

개발자 포털에 새 문제 또는 메모가 제출되면 다음 전자 메일 받는 사람 및 사용자가 전자 메일 알림을 받게 됩니다.

PurchasePublisherNotificationMessage
  • string

다음 전자 메일 받는 사람 및 사용자는 새 API 제품 구독에 대한 전자 메일 알림을 받게 됩니다.

QuotaLimitApproachingPublisherNotificationMessage
  • string

구독 사용량이 사용 할당량에 가까워지면 다음 전자 메일 받는 사람 및 사용자가 전자 메일 알림을 받게 됩니다.

RequestPublisherNotificationMessage
  • string

다음 전자 메일 수신자와 사용자는 승인이 필요한 API 제품에 대한 구독 요청에 대한 이메일 알림을 받게 됩니다.

RecipientsContractProperties

알림 매개 변수 계약입니다.

Name Type Description
emails
  • string[]

알림을 구독한 전자 메일 목록입니다.

users
  • string[]

알림을 구독한 사용자 목록입니다.