GET v1/Events/Subscriptions

User roles allowed to make this request: DomainAdministrator

Permissions required to make this request: Events.Read

Gets a list of Event Grid Domain Topic Subscriptions for the domain.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of events subscriptions or an empty list if none exists.

Response Message

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DomainId": "sample string 1",
    "Name": "sample string 2",
    "WebHookUri": "sample string 3",
    "EventTypes": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "DomainId": "sample string 1",
    "Name": "sample string 2",
    "WebHookUri": "sample string 3",
    "EventTypes": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfSubscriptionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.Events">
  <SubscriptionModel>
    <DomainId>sample string 1</DomainId>
    <EventTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </EventTypes>
    <Name>sample string 2</Name>
    <WebHookUri>sample string 3</WebHookUri>
  </SubscriptionModel>
  <SubscriptionModel>
    <DomainId>sample string 1</DomainId>
    <EventTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </EventTypes>
    <Name>sample string 2</Name>
    <WebHookUri>sample string 3</WebHookUri>
  </SubscriptionModel>
</ArrayOfSubscriptionModel>