PATCH v1/Events/Subscriptions/{name}

User roles allowed to make this request: DomainAdministrator

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

Updates an Event Grid Domain Topic Subscription.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

The subscription name.

string

Required

Body Parameters

The UpdateSubscriptionModel>

UpdateSubscriptionModel
NameDescriptionTypeAdditional information
Endpoint

The endpoint to use for the subcription.

URI

None.

EventTypes

The event types to subscribe.

Collection of string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<UpdateSubscriptionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.Events">
  <Endpoint>http://webapihelppage1.com/</Endpoint>
  <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>
</UpdateSubscriptionModel>

application/x-www-form-urlencoded

Sample:
Endpoint=Uri&EventTypes=IEnumerable`1

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

NoContent, if succeeded. The appropriate exception in case of failure. BadRequest in case of error.

Response Message

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.