POST v1/Events/Subscriptions

User roles allowed to make this request: DomainAdministrator

Permissions required to make this request: Events.Write Events.Read

Creates an Event Grid Domain Topic Subscription based on the given data.

Request Information

URI Parameters

None.

Body Parameters

The CreateSubscriptionModel.

CreateSubscriptionModel

Name	Description	Type	Additional information
EventSubscriptionName	The subscription name.	string	None.
Endpoint	The endpoint to use for the subcription.	URI	None.
EventTypes	The event types that will subscribe to.	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "EventSubscriptionName": "sample string 1",
  "Endpoint": "http://webapihelppage2.com",
  "EventTypes": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<CreateSubscriptionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.Events">
  <Endpoint>http://webapihelppage2.com/</Endpoint>
  <EventSubscriptionName>sample string 1</EventSubscriptionName>
  <EventTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </EventTypes>
</CreateSubscriptionModel>

application/x-www-form-urlencoded

Sample:

EventSubscriptionName=sample&Endpoint=Uri&EventTypes=IEnumerable`1

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Created, if succeeded. The appropriate exception in case of failure.

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.