Sdílet prostřednictvím

Workspace Notification - Get

Služba:
API Management
Verze rozhraní API:
2024-05-01

Získá podrobnosti o oznámení určeném jeho identifikátorem.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
notificationName
 path True

NotificationName

Identifikátor názvu oznámení.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName
 path True

string

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

Název služby API Management.
subscriptionId
 path True

string (uuid)

ID cílového předplatného. Hodnota musí být UUID.
workspaceId
 path True

string

minLength: 1
maxLength: 80
pattern: ^[^*#&+:<>?]+$

Identifikátor pracovního prostoru V aktuální instanci služby API Management musí být jedinečné.
api-version
 query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

NotificationContract

Text odpovědi obsahuje zadané oznámení.
Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

ApiManagementGetWorkspaceNotification

Ukázkový požadavek

GET 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

Ukázková odpověď

Stavový kód:
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"
      ]
    }
  }
}

Definice

Name Description
ErrorAdditionalInfo

Další informace o chybě správy prostředků
ErrorDetail

Podrobnosti o chybě.
ErrorResponse

Chybová odpověď
NotificationContract

Podrobnosti o oznámení.
NotificationName

Identifikátor názvu oznámení.
RecipientsContractProperties

Kontrakt parametru oznámení.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.
type

string

Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.
code

string

Kód chyby.
details

ErrorDetail[]

Podrobnosti o chybě.
message

string

Chybová zpráva.
target

string

Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

NotificationContract

Objekt

Podrobnosti o oznámení.

Name Typ Description
id

string

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Název prostředku
properties.description

string

Popis oznámení
properties.recipients

RecipientsContractProperties

Hodnoty parametru příjemce.
properties.title

string

minLength: 1
maxLength: 1000

Název oznámení.
type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

NotificationName

Výčet

Identifikátor názvu oznámení.

Hodnota Description
RequestPublisherNotificationMessage

Následující příjemci e-mailu a uživatelé dostanou e-mailová oznámení o žádostech o odběr pro produkty ROZHRANÍ API vyžadující schválení.
PurchasePublisherNotificationMessage

Následující příjemci e-mailu a uživatelé dostanou e-mailová oznámení o nových předplatných produktů rozhraní API.
NewApplicationNotificationMessage

Následující příjemci e-mailu a uživatelé dostanou e-mailová oznámení, když se do galerie aplikací odesílají nové aplikace.
BCC

Následující příjemci dostanou slepé kopie všech e-mailů odeslaných vývojářům.
NewIssuePublisherNotificationMessage

Následující příjemci e-mailu a uživatelé dostanou e-mailová oznámení, když se na portálu pro vývojáře odešle nový problém nebo komentář.
AccountClosedPublisher

Následující příjemci e-mailu a uživatelé dostanou e-mailová oznámení, když vývojář zavře svůj účet.
QuotaLimitApproachingPublisherNotificationMessage

Následující příjemci e-mailu a uživatelé dostanou e-mailová oznámení, když se využití předplatného blíží kvótě využití.

RecipientsContractProperties

Objekt

Kontrakt parametru oznámení.

Name Typ Description
emails

string[]

Seznam e-mailů přihlášených k odběru oznámení
users

string[]

Seznam uživatelů přihlášených k odběru oznámení