EventGridManagementClient
Azure EventGrid Management Client
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "management.azure.com",
"info": {
"description": "Azure EventGrid Management Client",
"title": "EventGridManagementClient",
"version": "2019-06-01",
"x-apisguru-categories": [
"cloud"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-06-01/EventGrid.json",
"version": "2.0"
}
],
"x-preferred": true,
"x-providerName": "azure.com",
"x-serviceName": "eventgrid-EventGrid",
"x-tags": [
"Azure",
"Microsoft"
]
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"azure_auth": {
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"description": "Azure Active Directory OAuth2 Flow",
"flow": "implicit",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"type": "oauth2"
}
},
"parameters": {
"ApiVersionParameter": {
"description": "Version of the API to be used with the client request.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
"FilterParameter": {
"description": "The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.",
"in": "query",
"name": "$filter",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
},
"SubscriptionIdParameter": {
"description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
"TopParameter": {
"description": "The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.",
"in": "query",
"name": "$top",
"required": false,
"type": "integer",
"x-ms-parameter-location": "method"
}
},
"paths": {
"/providers/Microsoft.EventGrid/operations": {
"get": {
"consumes": [],
"description": "List the available operations supported by the Microsoft.EventGrid resource provider.",
"operationId": "Operations_List",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OperationsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List available operations.",
"tags": [
"Operations"
],
"x-ms-examples": {
"Operations_List": {
"parameters": {
"api-version": "2019-06-01"
},
"responses": {
"200": {
"body": {
"value": [
{
"display": {
"description": "Registers the eventSubscription for the EventGrid resource provider and enables the creation of Event Grid subscriptions.",
"operation": "Registers the EventGrid Resource Provider",
"provider": "Microsoft Event Grid",
"resource": "EventGrid Resource Provider"
},
"name": "Microsoft.EventGrid/register/action",
"origin": "UserAndSystem"
},
{
"display": {
"description": "Create or update a eventSubscription",
"operation": "Write EventSubscription",
"provider": "Microsoft Event Grid",
"resource": "eventSubscriptions"
},
"name": "Microsoft.EventGrid/eventSubscriptions/write",
"origin": "UserAndSystem"
},
{
"display": {
"description": "Read a eventSubscription",
"operation": "Read EventSubscription",
"provider": "Microsoft Event Grid",
"resource": "eventSubscriptions"
},
"name": "Microsoft.EventGrid/eventSubscriptions/read",
"origin": "UserAndSystem"
},
{
"display": {
"description": "Delete a eventSubscription",
"operation": "Delete EventSubscription",
"provider": "Microsoft Event Grid",
"resource": "eventSubscriptions"
},
"name": "Microsoft.EventGrid/eventSubscriptions/delete",
"origin": "UserAndSystem"
},
{
"display": {
"description": "Create or update a topic",
"operation": "Write Topic",
"provider": "Microsoft Event Grid",
"resource": "topics"
},
"name": "Microsoft.EventGrid/topics/write",
"origin": "UserAndSystem"
},
{
"display": {
"description": "Read a topic",
"operation": "Read Topic",
"provider": "Microsoft Event Grid",
"resource": "topics"
},
"name": "Microsoft.EventGrid/topics/read",
"origin": "UserAndSystem"
},
{
"display": {
"description": "Delete a topic",
"operation": "Delete Topic",
"provider": "Microsoft Event Grid",
"resource": "topics"
},
"name": "Microsoft.EventGrid/topics/delete",
"origin": "UserAndSystem"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": null
}
}
},
"/providers/Microsoft.EventGrid/topicTypes": {
"get": {
"consumes": [],
"description": "List all registered topic types.",
"operationId": "TopicTypes_List",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TopicTypesListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
}
},
"summary": "List topic types.",
"tags": [
"TopicTypes"
],
"x-ms-examples": {
"TopicTypes_List": {
"parameters": {
"api-version": "2019-06-01"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Eventhub.Namespaces",
"name": "Microsoft.Eventhub.Namespaces",
"properties": {
"description": "Microsoft EventHubs service events.",
"displayName": "EventHubs Namespace",
"provider": "Microsoft.Eventhub",
"provisioningState": "Succeeded",
"resourceRegionType": "RegionalResource"
},
"type": "Microsoft.EventGrid/topicTypes"
},
{
"id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts",
"name": "Microsoft.Storage.StorageAccounts",
"properties": {
"description": "Microsoft Storage service events.",
"displayName": "Storage Accounts",
"provider": "Microsoft.Storage",
"provisioningState": "Succeeded",
"resourceRegionType": "RegionalResource"
},
"type": "Microsoft.EventGrid/topicTypes"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": null
}
}
},
"/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}": {
"get": {
"consumes": [],
"description": "Get information about a topic type.",
"operationId": "TopicTypes_Get",
"parameters": [
{
"description": "Name of the topic type.",
"in": "path",
"name": "topicTypeName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TopicTypeInfo"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
}
},
"summary": "Get a topic type.",
"tags": [
"TopicTypes"
],
"x-ms-examples": {
"TopicTypes_Get": {
"parameters": {
"api-version": "2019-06-01",
"topicTypeName": "Microsoft.Storage.StorageAccounts"
},
"responses": {
"200": {
"body": {
"id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts",
"name": "Microsoft.Storage.StorageAccounts",
"properties": {
"description": "Microsoft Storage service events.",
"displayName": "Storage Accounts",
"provider": "Microsoft.Storage",
"provisioningState": "Succeeded",
"resourceRegionType": "RegionalResource"
},
"type": "Microsoft.EventGrid/topicTypes"
}
}
}
}
}
}
},
"/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventTypes": {
"get": {
"consumes": [],
"description": "List event types for a topic type.",
"operationId": "TopicTypes_ListEventTypes",
"parameters": [
{
"description": "Name of the topic type.",
"in": "path",
"name": "topicTypeName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventTypesListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
}
},
"summary": "List event types.",
"tags": [
"TopicTypes"
],
"x-ms-examples": {
"TopicTypes_ListEventTypes": {
"parameters": {
"api-version": "2019-06-01",
"topicTypeName": "Microsoft.Storage.StorageAccounts"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobCreated",
"name": "Microsoft.Storage.BlobCreated",
"properties": {
"description": "Raised when a blob is created.",
"displayName": "Blob Created",
"schemaUrl": "tbd"
},
"type": "Microsoft.EventGrid/topicTypes/eventTypes"
},
{
"id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobDeleted",
"name": "Microsoft.Storage.BlobDeleted",
"properties": {
"description": "Raised when a blob is deleted.",
"displayName": "Blob Deleted",
"schemaUrl": "tbd"
},
"type": "Microsoft.EventGrid/topicTypes/eventTypes"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": null
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/domains": {
"get": {
"consumes": [],
"description": "List all the domains under an Azure subscription.",
"operationId": "Domains_ListBySubscription",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DomainsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List domains under an Azure subscription.",
"tags": [
"Domains"
],
"x-ms-examples": {
"Domains_ListBySubscription": {
"parameters": {
"api-version": "2019-06-01",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1",
"location": "westus2",
"name": "exampledomain1",
"properties": {
"endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/domains"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2",
"location": "westcentralus",
"name": "exampledomain2",
"properties": {
"endpoint": "https://exampledomain2.westcentralus-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/domains"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/eventSubscriptions": {
"get": {
"consumes": [],
"description": "List all aggregated global event subscriptions under a specific Azure subscription.",
"operationId": "EventSubscriptions_ListGlobalBySubscription",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventSubscriptionsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Get an aggregated list of all global event subscriptions under an Azure subscription.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_ListGlobalBySubscription": {
"parameters": {
"api-version": "2019-06-01",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2",
"name": "examplesubscription2",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "",
"subjectEndsWith": ""
},
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription4",
"name": "examplesubscription4",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "",
"subjectEndsWith": ""
},
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions": {
"get": {
"consumes": [],
"description": "List all event subscriptions from the given location under a specific Azure subscription.",
"operationId": "EventSubscriptions_ListRegionalBySubscription",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "Name of the location.",
"in": "path",
"name": "location",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventSubscriptionsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List all regional event subscriptions under an Azure subscription.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_ListRegionalBySubscription": {
"parameters": {
"api-version": "2019-06-01",
"location": "westus2",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10",
"name": "examplesubscription10",
"properties": {
"destination": {
"endpointType": "EventHub",
"properties": {
"resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"Finance",
"HR"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11",
"name": "examplesubscription11",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"Finance",
"HR"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions": {
"get": {
"consumes": [],
"description": "List all event subscriptions from the given location under a specific Azure subscription and topic type.",
"operationId": "EventSubscriptions_ListRegionalBySubscriptionForTopicType",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "Name of the location.",
"in": "path",
"name": "location",
"required": true,
"type": "string"
},
{
"description": "Name of the topic type.",
"in": "path",
"name": "topicTypeName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventSubscriptionsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List all regional event subscriptions under an Azure subscription for a topic type.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_ListRegionalBySubscriptionForTopicType": {
"parameters": {
"api-version": "2019-06-01",
"location": "westus2",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
"topicTypeName": "Microsoft.EventHub.namespaces"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10",
"name": "examplesubscription10",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"Finance",
"HR"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11",
"name": "examplesubscription11",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"Finance",
"HR"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions": {
"get": {
"consumes": [],
"description": "List all global event subscriptions under an Azure subscription for a topic type.",
"operationId": "EventSubscriptions_ListGlobalBySubscriptionForTopicType",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "Name of the topic type.",
"in": "path",
"name": "topicTypeName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventSubscriptionsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List all global event subscriptions for a topic type.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_ListGlobalBySubscriptionForTopicType": {
"parameters": {
"api-version": "2019-06-01",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
"topicTypeName": "Microsoft.Resources.Subscriptions"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
"name": "examplesubscription3",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"Finance",
"HR"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics": {
"get": {
"consumes": [],
"description": "List all the topics under an Azure subscription.",
"operationId": "Topics_ListBySubscription",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TopicsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List topics under an Azure subscription.",
"tags": [
"Topics"
],
"x-ms-examples": {
"Topics_ListBySubscription": {
"parameters": {
"api-version": "2019-06-01",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
"location": "westus2",
"name": "exampletopic1",
"properties": {
"endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/topics"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2",
"location": "westcentralus",
"name": "exampletopic2",
"properties": {
"endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/topics"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains": {
"get": {
"consumes": [],
"description": "List all the domains under a resource group.",
"operationId": "Domains_ListByResourceGroup",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DomainsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List domains under a resource group.",
"tags": [
"Domains"
],
"x-ms-examples": {
"Domains_ListByResourceGroup": {
"parameters": {
"api-version": "2019-06-01",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1",
"location": "westus2",
"name": "exampledomain1",
"properties": {
"endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/domains"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2",
"location": "westcentralus",
"name": "exampledomain2",
"properties": {
"endpoint": "https://exampledomain2.westcentralus-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/domains"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}": {
"delete": {
"consumes": [],
"description": "Delete existing domain.",
"operationId": "Domains_Delete",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the domain.",
"in": "path",
"name": "domainName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"202": {
"description": "Accepted"
},
"204": {
"description": "NoContent"
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
}
},
"summary": "Delete a domain.",
"tags": [
"Domains"
],
"x-ms-examples": {
"Domains_Delete": {
"parameters": {
"api-version": "2019-06-01",
"domainName": "exampledomain1",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"202": {},
"204": {}
}
}
},
"x-ms-long-running-operation": true
},
"get": {
"consumes": [],
"description": "Get properties of a domain.",
"operationId": "Domains_Get",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the domain.",
"in": "path",
"name": "domainName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Domain"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Get a domain.",
"tags": [
"Domains"
],
"x-ms-examples": {
"Domains_Get": {
"parameters": {
"api-version": "2019-06-01",
"domainName": "exampledomain2",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2",
"location": "westcentralus",
"name": "exampledomain2",
"properties": {
"endpoint": "https://exampledomain2.westcentralus-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/domains"
}
}
}
}
}
},
"patch": {
"description": "Asynchronously updates a domain with the specified parameters.",
"operationId": "Domains_Update",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the domain.",
"in": "path",
"name": "domainName",
"required": true,
"type": "string"
},
{
"description": "Domain update information.",
"in": "body",
"name": "domainUpdateParameters",
"required": true,
"schema": {
"$ref": "#/definitions/DomainUpdateParameters"
}
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"201": {
"description": "Domain update request accepted.",
"schema": {
"$ref": "#/definitions/Domain"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Update a domain.",
"tags": [
"Domains"
],
"x-ms-examples": {
"Domains_Update": {
"parameters": {
"api-version": "2019-06-01",
"domainName": "exampledomain1",
"domainUpdateParameters": {
"tags": {
"tag1": "value1",
"tag2": "value2"
}
},
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1",
"location": "westus2",
"name": "exampledomain1",
"properties": {
"endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/domains"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"put": {
"description": "Asynchronously creates or updates a new domain with the specified parameters.",
"operationId": "Domains_CreateOrUpdate",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the domain.",
"in": "path",
"name": "domainName",
"required": true,
"type": "string"
},
{
"description": "Domain information.",
"in": "body",
"name": "domainInfo",
"required": true,
"schema": {
"$ref": "#/definitions/Domain"
}
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/Domain"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Create or update a domain.",
"tags": [
"Domains"
],
"x-ms-examples": {
"Domains_CreateOrUpdate": {
"parameters": {
"api-version": "2019-06-01",
"domainInfo": {
"location": "westus2",
"tags": {
"tag1": "value1",
"tag2": "value2"
}
},
"domainName": "exampledomain1",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1",
"location": "westus2",
"name": "exampledomain1",
"properties": {
"endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/domains"
}
}
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/listKeys": {
"post": {
"consumes": [],
"description": "List the two keys used to publish to a domain.",
"operationId": "Domains_ListSharedAccessKeys",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the domain.",
"in": "path",
"name": "domainName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DomainSharedAccessKeys"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List keys for a domain.",
"tags": [
"Domains"
],
"x-ms-examples": {
"Domains_ListSharedAccessKeys": {
"parameters": {
"api-version": "2019-06-01",
"domainName": "exampledomain2",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"key1": "Rqfq5wWxtQnIQJyswP0Uh/hqQfDDMUOYyQSYEpx5e5g=",
"key2": "sesymbkIXMtZVqXEFHarJmdGmZjjnY+BZC8yRD/FeuA="
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/regenerateKey": {
"post": {
"description": "Regenerate a shared access key for a domain.",
"operationId": "Domains_RegenerateKey",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the domain.",
"in": "path",
"name": "domainName",
"required": true,
"type": "string"
},
{
"description": "Request body to regenerate key.",
"in": "body",
"name": "regenerateKeyRequest",
"required": true,
"schema": {
"$ref": "#/definitions/DomainRegenerateKeyRequest"
}
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DomainSharedAccessKeys"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Regenerate key for a domain.",
"tags": [
"Domains"
],
"x-ms-examples": {
"Domains_RegenerateKey": {
"parameters": {
"api-version": "2019-06-01",
"domainName": "exampledomain2",
"regenerateKeyRequest": {
"keyName": "key1"
},
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"key1": "Rqfq5wWxtQnIQJyswP0Uh/hqQfDDMUOYyQSYEpx5e5g=",
"key2": "sesymbkIXMtZVqXEFHarJmdGmZjjnY+BZC8yRD/FeuA="
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics": {
"get": {
"consumes": [],
"description": "List all the topics in a domain.",
"operationId": "DomainTopics_ListByDomain",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Domain name.",
"in": "path",
"name": "domainName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DomainTopicsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List domain topics.",
"tags": [
"DomainTopics"
],
"x-ms-examples": {
"DomainTopics_ListByDomain": {
"parameters": {
"api-version": "2019-06-01",
"domainName": "exampledomain2",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/devexprg/providers/Microsoft.EventGrid/domains/domainCli100/topics/domainCli100topic1",
"name": "domainCli100topic1",
"properties": {
"provisioningState": "Succeeded"
},
"type": "Microsoft.EventGrid/domains/topics"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/devexprg/providers/Microsoft.EventGrid/domains/domainCli100/topics/domainCli100topic2",
"name": "domainCli100topic2",
"properties": {
"provisioningState": "Succeeded"
},
"type": "Microsoft.EventGrid/domains/topics"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}": {
"delete": {
"consumes": [],
"description": "Delete existing domain topic.",
"operationId": "DomainTopics_Delete",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the domain.",
"in": "path",
"name": "domainName",
"required": true,
"type": "string"
},
{
"description": "Name of the domain topic.",
"in": "path",
"name": "domainTopicName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"202": {
"description": "Accepted"
},
"204": {
"description": "NoContent"
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
}
},
"summary": "Delete a domain topic.",
"tags": [
"DomainTopics"
],
"x-ms-examples": {
"DomainTopics_Delete": {
"parameters": {
"api-version": "2019-06-01",
"domainName": "exampledomain1",
"domainTopicName": "exampledomaintopic1",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"202": {},
"204": {}
}
}
},
"x-ms-long-running-operation": true
},
"get": {
"consumes": [],
"description": "Get properties of a domain topic.",
"operationId": "DomainTopics_Get",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the domain.",
"in": "path",
"name": "domainName",
"required": true,
"type": "string"
},
{
"description": "Name of the topic.",
"in": "path",
"name": "domainTopicName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DomainTopic"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Get a domain topic.",
"tags": [
"DomainTopics"
],
"x-ms-examples": {
"DomainTopics_Get": {
"parameters": {
"api-version": "2019-06-01",
"domainName": "exampledomain2",
"domainTopicName": "topic1",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2/topics/topic1",
"name": "topic1",
"properties": {
"provisioningState": "Succeeded"
},
"type": "Microsoft.EventGrid/domains/topics"
}
}
}
}
}
},
"put": {
"consumes": [],
"description": "Asynchronously creates or updates a new domain topic with the specified parameters.",
"operationId": "DomainTopics_CreateOrUpdate",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the domain.",
"in": "path",
"name": "domainName",
"required": true,
"type": "string"
},
{
"description": "Name of the domain topic.",
"in": "path",
"name": "domainTopicName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/DomainTopic"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Create or update a domain topic.",
"tags": [
"DomainTopics"
],
"x-ms-examples": {
"DomainTopics_CreateOrUpdate": {
"parameters": {
"api-version": "2019-06-01",
"domainName": "exampledomain1",
"domainTopicName": "exampledomaintopic1",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1/topics/exampledomaintopic1",
"name": "exampledomaintopic1",
"properties": {
"provisioningState": "Succeeded"
},
"type": "Microsoft.EventGrid/domains/topics"
}
}
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/providers/Microsoft.EventGrid/eventSubscriptions": {
"get": {
"consumes": [],
"description": "List all event subscriptions that have been created for a specific domain topic.",
"operationId": "EventSubscriptions_ListByDomainTopic",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the top level domain.",
"in": "path",
"name": "domainName",
"required": true,
"type": "string"
},
{
"description": "Name of the domain topic.",
"in": "path",
"name": "topicName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventSubscriptionsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List all event subscriptions for a specific domain topic.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_ListByDomainTopic": {
"parameters": {
"api-version": "2019-06-01",
"domainName": "domain1",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
"topicName": "topic1"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/domain1/topics/topic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
"name": "examplesubscription1",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "",
"subjectEndsWith": ""
},
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/domains/domain1/topics/topic1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/domain1/topics/topic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2",
"name": "examplesubscription2",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "",
"subjectEndsWith": ""
},
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/domains/domain1/topics/topic1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/domain1/topics/topic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
"name": "examplesubscription3",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "",
"subjectEndsWith": ""
},
"labels": [],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/domains/domain1/topics/topic1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/eventSubscriptions": {
"get": {
"consumes": [],
"description": "List all global event subscriptions under a specific Azure subscription and resource group.",
"operationId": "EventSubscriptions_ListGlobalByResourceGroup",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventSubscriptionsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List all global event subscriptions under an Azure subscription and resource group.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_ListGlobalByResourceGroup": {
"parameters": {
"api-version": "2019-06-01",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2",
"name": "examplesubscription2",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "",
"subjectEndsWith": ""
},
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription4",
"name": "examplesubscription4",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "",
"subjectEndsWith": ""
},
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions": {
"get": {
"consumes": [],
"description": "List all event subscriptions from the given location under a specific Azure subscription and resource group.",
"operationId": "EventSubscriptions_ListRegionalByResourceGroup",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the location.",
"in": "path",
"name": "location",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventSubscriptionsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List all regional event subscriptions under an Azure subscription and resource group.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_ListRegionalByResourceGroup": {
"parameters": {
"api-version": "2019-06-01",
"location": "westus2",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10",
"name": "examplesubscription10",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"Finance",
"HR"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11",
"name": "examplesubscription11",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"Finance",
"HR"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions": {
"get": {
"consumes": [],
"description": "List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.",
"operationId": "EventSubscriptions_ListRegionalByResourceGroupForTopicType",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the location.",
"in": "path",
"name": "location",
"required": true,
"type": "string"
},
{
"description": "Name of the topic type.",
"in": "path",
"name": "topicTypeName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventSubscriptionsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List all regional event subscriptions under an Azure subscription and resource group for a topic type.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_ListRegionalByResourceGroupForTopicType": {
"parameters": {
"api-version": "2019-06-01",
"location": "westus2",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
"topicTypeName": "Microsoft.EventHub.namespaces"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10",
"name": "examplesubscription10",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"Finance",
"HR"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11",
"name": "examplesubscription11",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"Finance",
"HR"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions": {
"get": {
"consumes": [],
"description": "List all global event subscriptions under a resource group for a specific topic type.",
"operationId": "EventSubscriptions_ListGlobalByResourceGroupForTopicType",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the topic type.",
"in": "path",
"name": "topicTypeName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventSubscriptionsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List all global event subscriptions under a resource group for a topic type.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_ListGlobalByResourceGroupForTopicType": {
"parameters": {
"api-version": "2019-06-01",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
"topicTypeName": "Microsoft.Resources.ResourceGroups"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
"name": "examplesubscription3",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"Finance",
"HR"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics": {
"get": {
"consumes": [],
"description": "List all the topics under a resource group.",
"operationId": "Topics_ListByResourceGroup",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TopicsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List topics under a resource group.",
"tags": [
"Topics"
],
"x-ms-examples": {
"Topics_ListByResourceGroup": {
"parameters": {
"api-version": "2019-06-01",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
"location": "westus2",
"name": "exampletopic1",
"properties": {
"endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/topics"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2",
"location": "westcentralus",
"name": "exampletopic2",
"properties": {
"endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/topics"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}": {
"delete": {
"consumes": [],
"description": "Delete existing topic.",
"operationId": "Topics_Delete",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the topic.",
"in": "path",
"name": "topicName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"202": {
"description": "Accepted"
},
"204": {
"description": "NoContent"
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
}
},
"summary": "Delete a topic.",
"tags": [
"Topics"
],
"x-ms-examples": {
"Topics_Delete": {
"parameters": {
"api-version": "2019-06-01",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
"topicName": "exampletopic1"
},
"responses": {
"202": {},
"204": {}
}
}
},
"x-ms-long-running-operation": true
},
"get": {
"consumes": [],
"description": "Get properties of a topic.",
"operationId": "Topics_Get",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the topic.",
"in": "path",
"name": "topicName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Topic"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Get a topic.",
"tags": [
"Topics"
],
"x-ms-examples": {
"Topics_Get": {
"parameters": {
"api-version": "2019-06-01",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
"topicName": "exampletopic2"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2",
"location": "westcentralus",
"name": "exampletopic2",
"properties": {
"endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/topics"
}
}
}
}
}
},
"patch": {
"description": "Asynchronously updates a topic with the specified parameters.",
"operationId": "Topics_Update",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the topic.",
"in": "path",
"name": "topicName",
"required": true,
"type": "string"
},
{
"description": "Topic update information.",
"in": "body",
"name": "topicUpdateParameters",
"required": true,
"schema": {
"$ref": "#/definitions/TopicUpdateParameters"
}
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"201": {
"description": "Topic update request accepted.",
"schema": {
"$ref": "#/definitions/Topic"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Update a topic.",
"tags": [
"Topics"
],
"x-ms-examples": {
"Topics_Update": {
"parameters": {
"api-version": "2019-06-01",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
"topicName": "exampletopic1",
"topicUpdateParameters": {
"tags": {
"tag1": "value1",
"tag2": "value2"
}
}
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
"location": "westus2",
"name": "exampletopic1",
"properties": {
"endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/topics"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"put": {
"description": "Asynchronously creates a new topic with the specified parameters.",
"operationId": "Topics_CreateOrUpdate",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the topic.",
"in": "path",
"name": "topicName",
"required": true,
"type": "string"
},
{
"description": "Topic information.",
"in": "body",
"name": "topicInfo",
"required": true,
"schema": {
"$ref": "#/definitions/Topic"
}
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/Topic"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Create a topic.",
"tags": [
"Topics"
],
"x-ms-examples": {
"Topics_CreateOrUpdate": {
"parameters": {
"api-version": "2019-06-01",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
"topicInfo": {
"location": "westus2",
"tags": {
"tag1": "value1",
"tag2": "value2"
}
},
"topicName": "exampletopic1"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
"location": "westus2",
"name": "exampletopic1",
"properties": {
"endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events",
"provisioningState": "Succeeded"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"type": "Microsoft.EventGrid/topics"
}
}
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/listKeys": {
"post": {
"consumes": [],
"description": "List the two keys used to publish to a topic.",
"operationId": "Topics_ListSharedAccessKeys",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the topic.",
"in": "path",
"name": "topicName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TopicSharedAccessKeys"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List keys for a topic.",
"tags": [
"Topics"
],
"x-ms-examples": {
"Topics_ListSharedAccessKeys": {
"parameters": {
"api-version": "2019-06-01",
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
"topicName": "exampletopic2"
},
"responses": {
"200": {
"body": {
"key1": "Rqfq5wWxtQnIQJyswP0Uh/hqQfDDMUOYyQSYEpx5e5g=",
"key2": "sesymbkIXMtZVqXEFHarJmdGmZjjnY+BZC8yRD/FeuA="
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/regenerateKey": {
"post": {
"description": "Regenerate a shared access key for a topic.",
"operationId": "Topics_RegenerateKey",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Name of the topic.",
"in": "path",
"name": "topicName",
"required": true,
"type": "string"
},
{
"description": "Request body to regenerate key.",
"in": "body",
"name": "regenerateKeyRequest",
"required": true,
"schema": {
"$ref": "#/definitions/TopicRegenerateKeyRequest"
}
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TopicSharedAccessKeys"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Regenerate key for a topic.",
"tags": [
"Topics"
],
"x-ms-examples": {
"Topics_RegenerateKey": {
"parameters": {
"api-version": "2019-06-01",
"regenerateKeyRequest": {
"keyName": "key1"
},
"resourceGroupName": "examplerg",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
"topicName": "exampletopic2"
},
"responses": {
"200": {
"body": {
"key1": "Rqfq5wWxtQnIQJyswP0Uh/hqQfDDMUOYyQSYEpx5e5g=",
"key2": "sesymbkIXMtZVqXEFHarJmdGmZjjnY+BZC8yRD/FeuA="
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventSubscriptions": {
"get": {
"consumes": [],
"description": "List all event subscriptions that have been created for a specific topic.",
"operationId": "EventSubscriptions_ListByResource",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Namespace of the provider of the topic.",
"in": "path",
"name": "providerNamespace",
"required": true,
"type": "string"
},
{
"description": "Name of the resource type.",
"in": "path",
"name": "resourceTypeName",
"required": true,
"type": "string"
},
{
"description": "Name of the resource.",
"in": "path",
"name": "resourceName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventSubscriptionsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List all event subscriptions for a specific topic.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_ListByResource": {
"parameters": {
"api-version": "2019-06-01",
"providerNamespace": "Microsoft.EventGrid",
"resourceGroupName": "examplerg",
"resourceName": "exampletopic2",
"resourceTypeName": "topics",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
"name": "examplesubscription1",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "",
"subjectEndsWith": ""
},
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2",
"name": "examplesubscription2",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "",
"subjectEndsWith": ""
},
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
},
{
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
"name": "examplesubscription3",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "",
"subjectEndsWith": ""
},
"labels": [],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventTypes": {
"get": {
"consumes": [],
"description": "List event types for a topic.",
"operationId": "Topics_ListEventTypes",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"description": "The name of the resource group within the user's subscription.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Namespace of the provider of the topic.",
"in": "path",
"name": "providerNamespace",
"required": true,
"type": "string"
},
{
"description": "Name of the topic type.",
"in": "path",
"name": "resourceTypeName",
"required": true,
"type": "string"
},
{
"description": "Name of the topic.",
"in": "path",
"name": "resourceName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventTypesListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "List topic event types.",
"tags": [
"Topics"
],
"x-ms-examples": {
"Topics_ListEventTypes": {
"parameters": {
"api-version": "2019-06-01",
"providerNamespace": "Microsoft.Storage",
"resourceGroupName": "examplerg",
"resourceName": "ExampleStorageAccount",
"resourceTypeName": "storageAccounts",
"subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobCreated",
"name": "Microsoft.Storage.BlobCreated",
"properties": {
"description": "Raised when a blob is created.",
"displayName": "Blob Created",
"schemaUrl": "tbd"
},
"type": "Microsoft.EventGrid/topicTypes/eventTypes"
},
{
"id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobDeleted",
"name": "Microsoft.Storage.BlobDeleted",
"properties": {
"description": "Raised when a blob is deleted.",
"displayName": "Blob Deleted",
"schemaUrl": "tbd"
},
"type": "Microsoft.EventGrid/topicTypes/eventTypes"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": null
}
}
},
"/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}": {
"delete": {
"consumes": [],
"description": "Delete an existing event subscription.",
"operationId": "EventSubscriptions_Delete",
"parameters": [
{
"description": "The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.",
"in": "path",
"name": "scope",
"required": true,
"type": "string",
"x-ms-skip-url-encoding": true
},
{
"description": "Name of the event subscription.",
"in": "path",
"name": "eventSubscriptionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK"
},
"202": {
"description": "Accepted"
},
"204": {
"description": "NoContent"
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
}
},
"summary": "Delete an event subscription.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_DeleteForCustomTopic": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription1",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
},
"EventSubscriptions_DeleteForResource": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription10",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
},
"EventSubscriptions_DeleteForResourceGroup": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription2",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
},
"EventSubscriptions_DeleteForSubscription": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription3",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
},
"x-ms-long-running-operation": true
},
"get": {
"consumes": [],
"description": "Get properties of an event subscription.",
"operationId": "EventSubscriptions_Get",
"parameters": [
{
"description": "The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.",
"in": "path",
"name": "scope",
"required": true,
"type": "string",
"x-ms-skip-url-encoding": true
},
{
"description": "Name of the event subscription.",
"in": "path",
"name": "eventSubscriptionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventSubscription"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Get an event subscription.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_GetForCustomTopic": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription1",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
"name": "examplesubscription1",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"label1",
"label2"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
},
"EventSubscriptions_GetForResource": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription1",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
"name": "examplesubscription1",
"properties": {
"destination": {
"endpointType": "EventHub",
"properties": {
"resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"label1",
"label2"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
},
"EventSubscriptions_GetForResourceGroup": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription2",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2",
"name": "examplesubscription2",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"label1",
"label2"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
},
"EventSubscriptions_GetForSubscription": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription3",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
"name": "examplesubscription3",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"label1",
"label2"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
}
}
},
"patch": {
"description": "Asynchronously updates an existing event subscription.",
"operationId": "EventSubscriptions_Update",
"parameters": [
{
"description": "The scope of existing event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.",
"in": "path",
"name": "scope",
"required": true,
"type": "string",
"x-ms-skip-url-encoding": true
},
{
"description": "Name of the event subscription to be updated.",
"in": "path",
"name": "eventSubscriptionName",
"required": true,
"type": "string"
},
{
"description": "Updated event subscription information.",
"in": "body",
"name": "eventSubscriptionUpdateParameters",
"required": true,
"schema": {
"$ref": "#/definitions/EventSubscriptionUpdateParameters"
}
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"201": {
"description": "EventSubscription update request accepted.",
"schema": {
"$ref": "#/definitions/EventSubscription"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Update an event subscription.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_UpdateForCustomTopic": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription1",
"eventSubscriptionUpdateParameters": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": true,
"subjectBeginsWith": "existingPrefix",
"subjectEndsWith": "newSuffix"
},
"labels": [
"label1",
"label2"
]
},
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
"name": "examplesubscription1",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": true,
"subjectBeginsWith": "existingPrefix",
"subjectEndsWith": "newSuffix"
},
"labels": [
"label1",
"label2"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
},
"EventSubscriptions_UpdateForResource": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription1",
"eventSubscriptionUpdateParameters": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": true,
"subjectBeginsWith": "existingPrefix",
"subjectEndsWith": "newSuffix"
},
"labels": [
"label1",
"label2"
]
},
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
"name": "examplesubscription1",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": true,
"subjectBeginsWith": "existingPrefix",
"subjectEndsWith": "newSuffix"
},
"labels": [],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
},
"EventSubscriptions_UpdateForResourceGroup": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription2",
"eventSubscriptionUpdateParameters": {
"destination": {
"endpointType": "EventHub",
"properties": {
"resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
}
},
"filter": {
"isSubjectCaseSensitive": true,
"subjectBeginsWith": "existingPrefix",
"subjectEndsWith": "newSuffix"
},
"labels": [
"label1",
"label2"
]
},
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2",
"name": "examplesubscription2",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": true,
"subjectBeginsWith": "existingPrefix",
"subjectEndsWith": "newSuffix"
},
"labels": [],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
},
"EventSubscriptions_UpdateForSubscription": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription3",
"eventSubscriptionUpdateParameters": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": true,
"subjectBeginsWith": "existingPrefix",
"subjectEndsWith": "newSuffix"
},
"labels": [
"label1",
"label2"
]
},
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
"name": "examplesubscription3",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": true,
"subjectBeginsWith": "existingPrefix",
"subjectEndsWith": "newSuffix"
},
"labels": [],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"put": {
"description": "Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.",
"operationId": "EventSubscriptions_CreateOrUpdate",
"parameters": [
{
"description": "The identifier of the resource to which the event subscription needs to be created or updated. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.",
"in": "path",
"name": "scope",
"required": true,
"type": "string",
"x-ms-skip-url-encoding": true
},
{
"description": "Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.",
"in": "path",
"name": "eventSubscriptionName",
"required": true,
"type": "string"
},
{
"description": "Event subscription properties containing the destination and filter information.",
"in": "body",
"name": "eventSubscriptionInfo",
"required": true,
"schema": {
"$ref": "#/definitions/EventSubscription"
}
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"201": {
"description": "EventSubscription CreateOrUpdate request accepted.",
"schema": {
"$ref": "#/definitions/EventSubscription"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Create or update an event subscription.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionInfo": {
"properties": {
"deadLetterDestination": {
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "contosocontainer",
"resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"
}
},
"destination": {
"endpointType": "EventHub",
"properties": {
"resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
}
}
},
"eventSubscriptionName": "examplesubscription1",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
"name": "examplesubscription1",
"properties": {
"deadLetterDestination": {
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "contosocontainer",
"resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"
}
},
"destination": {
"endpointType": "EventHub",
"properties": {
"resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": null,
"provisioningState": "Creating",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
},
"EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionInfo": {
"properties": {
"deadLetterDestination": {
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "contosocontainer",
"resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"
}
},
"destination": {
"endpointType": "HybridConnection",
"properties": {
"resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
}
}
},
"eventSubscriptionName": "examplesubscription1",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
"name": "examplesubscription1",
"properties": {
"deadLetterDestination": {
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "contosocontainer",
"resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"
}
},
"destination": {
"endpointType": "HybridConnection",
"properties": {
"resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": null,
"provisioningState": "Creating",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
},
"EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionInfo": {
"properties": {
"deadLetterDestination": {
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "contosocontainer",
"resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"
}
},
"destination": {
"endpointType": "StorageQueue",
"properties": {
"queueName": "queue1",
"resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
}
}
},
"eventSubscriptionName": "examplesubscription1",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
"name": "examplesubscription1",
"properties": {
"deadLetterDestination": {
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "contosocontainer",
"resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"
}
},
"destination": {
"endpointType": "StorageQueue",
"properties": {
"queueName": "queue1",
"resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": null,
"provisioningState": "Creating",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
},
"EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionInfo": {
"properties": {
"destination": {
"endpointType": "EventHub",
"properties": {
"resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
}
}
},
"eventSubscriptionName": "examplesubscription1",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
"name": "examplesubscription1",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
},
"EventSubscriptions_CreateOrUpdateForResource": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionInfo": {
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
}
}
},
"eventSubscriptionName": "examplesubscription10",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10",
"name": "examplesubscription10",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
},
"EventSubscriptions_CreateOrUpdateForResourceGroup": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionInfo": {
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
}
}
},
"eventSubscriptionName": "examplesubscription2",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2",
"name": "examplesubscription2",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
},
"EventSubscriptions_CreateOrUpdateForSubscription": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionInfo": {
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false
}
}
},
"eventSubscriptionName": "examplesubscription3",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
"name": "examplesubscription3",
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "",
"subjectEndsWith": ""
},
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"type": "Microsoft.EventGrid/eventSubscriptions"
}
}
}
}
},
"x-ms-long-running-operation": true
}
},
"/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}/getFullUrl": {
"post": {
"consumes": [],
"description": "Get the full endpoint URL for an event subscription.",
"operationId": "EventSubscriptions_GetFullUrl",
"parameters": [
{
"description": "The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.",
"in": "path",
"name": "scope",
"required": true,
"type": "string",
"x-ms-skip-url-encoding": true
},
{
"description": "Name of the event subscription.",
"in": "path",
"name": "eventSubscriptionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventSubscriptionFullUrl"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"summary": "Get full URL of an event subscription.",
"tags": [
"EventSubscriptions"
],
"x-ms-examples": {
"EventSubscriptions_GetFullUrlForCustomTopic": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription1",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2"
},
"responses": {
"200": {
"body": {
"endpointUrl": "https://requestb.in/15ksip71"
}
}
}
},
"EventSubscriptions_GetFullUrlForResource": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription1",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
},
"responses": {
"200": {
"body": {
"endpointUrl": "https://requestb.in/15ksip71"
}
}
}
},
"EventSubscriptions_GetFullUrlForResourceGroup": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription2",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"responses": {
"200": {
"body": {
"endpointUrl": "https://requestb.in/15ksip71"
}
}
}
},
"EventSubscriptions_GetFullUrlForSubscription": {
"parameters": {
"api-version": "2019-06-01",
"eventSubscriptionName": "examplesubscription3",
"scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
},
"responses": {
"200": {
"body": {
"endpointUrl": "https://requestb.in/15ksip71"
}
}
}
}
}
}
}
},
"definitions": {
"AdvancedFilter": {
"description": "This is the base type that represents an advanced filter. To configure an advanced filter, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class such as BoolEqualsAdvancedFilter, NumberInAdvancedFilter, StringEqualsAdvancedFilter etc. depending on the type of the key based on which you want to filter.",
"discriminator": "operatorType",
"properties": {
"key": {
"description": "The field/property in the event based on which you want to filter.",
"type": "string"
},
"operatorType": {
"description": "The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.",
"enum": [
"NumberIn",
"NumberNotIn",
"NumberLessThan",
"NumberGreaterThan",
"NumberLessThanOrEquals",
"NumberGreaterThanOrEquals",
"BoolEquals",
"StringIn",
"StringNotIn",
"StringBeginsWith",
"StringEndsWith",
"StringContains"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "AdvancedFilterOperatorType"
}
}
},
"required": [
"operatorType"
],
"type": "object"
},
"BoolEqualsAdvancedFilter": {
"allOf": [
{
"$ref": "#/definitions/AdvancedFilter"
}
],
"description": "BoolEquals Advanced Filter.",
"properties": {
"value": {
"description": "The boolean filter value.",
"type": "boolean"
}
},
"type": "object",
"x-ms-discriminator-value": "BoolEquals"
},
"DeadLetterDestination": {
"description": "Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.",
"discriminator": "endpointType",
"properties": {
"endpointType": {
"description": "Type of the endpoint for the dead letter destination",
"enum": [
"StorageBlob"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "DeadLetterEndPointType"
}
}
},
"required": [
"endpointType"
],
"type": "object"
},
"Domain": {
"allOf": [
{
"$ref": "#/definitions/TrackedResource"
}
],
"description": "EventGrid Domain.",
"properties": {
"properties": {
"$ref": "#/definitions/DomainProperties",
"description": "Properties of the domain.",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"DomainProperties": {
"description": "Properties of the Domain.",
"properties": {
"endpoint": {
"description": "Endpoint for the domain.",
"readOnly": true,
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the domain.",
"enum": [
"Creating",
"Updating",
"Deleting",
"Succeeded",
"Canceled",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "DomainProvisioningState"
}
}
},
"type": "object"
},
"DomainRegenerateKeyRequest": {
"description": "Domain regenerate share access key request.",
"properties": {
"keyName": {
"description": "Key name to regenerate key1 or key2.",
"type": "string"
}
},
"required": [
"keyName"
],
"type": "object"
},
"DomainSharedAccessKeys": {
"description": "Shared access keys of the Domain.",
"properties": {
"key1": {
"description": "Shared access key1 for the domain.",
"type": "string"
},
"key2": {
"description": "Shared access key2 for the domain.",
"type": "string"
}
},
"type": "object"
},
"DomainTopic": {
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"description": "Domain Topic.",
"properties": {
"properties": {
"$ref": "#/definitions/DomainTopicProperties",
"description": "Properties of the Domain Topic.",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"DomainTopicProperties": {
"description": "Properties of the Domain Topic.",
"properties": {
"provisioningState": {
"description": "Provisioning state of the domain topic.",
"enum": [
"Creating",
"Updating",
"Deleting",
"Succeeded",
"Canceled",
"Failed"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "DomainTopicProvisioningState"
}
}
},
"type": "object"
},
"DomainTopicsListResult": {
"description": "Result of the List Domain Topics operation.",
"properties": {
"nextLink": {
"description": "A link for the next page of domain topics.",
"type": "string"
},
"value": {
"description": "A collection of Domain Topics.",
"items": {
"$ref": "#/definitions/DomainTopic"
},
"type": "array"
}
},
"type": "object"
},
"DomainUpdateParameters": {
"description": "Properties of the Domain update.",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Tags of the domains resource.",
"type": "object"
}
},
"type": "object"
},
"DomainsListResult": {
"description": "Result of the List Domains operation.",
"properties": {
"nextLink": {
"description": "A link for the next page of domains.",
"type": "string"
},
"value": {
"description": "A collection of Domains.",
"items": {
"$ref": "#/definitions/Domain"
},
"type": "array"
}
},
"type": "object"
},
"EventHubEventSubscriptionDestination": {
"allOf": [
{
"$ref": "#/definitions/EventSubscriptionDestination"
}
],
"description": "Information about the event hub destination for an event subscription",
"properties": {
"properties": {
"$ref": "#/definitions/EventHubEventSubscriptionDestinationProperties",
"description": "Event Hub Properties of the event subscription destination",
"x-ms-client-flatten": true
}
},
"type": "object",
"x-ms-discriminator-value": "EventHub"
},
"EventHubEventSubscriptionDestinationProperties": {
"description": "The properties for a event hub destination.",
"properties": {
"resourceId": {
"description": "The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.",
"type": "string"
}
},
"type": "object"
},
"EventSubscription": {
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"description": "Event Subscription",
"properties": {
"properties": {
"$ref": "#/definitions/EventSubscriptionProperties",
"description": "Properties of the event subscription",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"EventSubscriptionDestination": {
"description": "Information about the destination for an event subscription",
"discriminator": "endpointType",
"properties": {
"endpointType": {
"description": "Type of the endpoint for the event subscription destination",
"enum": [
"WebHook",
"EventHub",
"StorageQueue",
"HybridConnection",
"ServiceBusQueue"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "EndpointType"
}
}
},
"required": [
"endpointType"
],
"type": "object"
},
"EventSubscriptionFilter": {
"description": "Filter for the Event Subscription.",
"properties": {
"advancedFilters": {
"description": "An array of advanced filters that are used for filtering event subscriptions.",
"items": {
"$ref": "#/definitions/AdvancedFilter"
},
"type": "array"
},
"includedEventTypes": {
"description": "A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.",
"items": {
"type": "string"
},
"type": "array"
},
"isSubjectCaseSensitive": {
"default": false,
"description": "Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter \r\nshould be compared in a case sensitive manner.",
"type": "boolean"
},
"subjectBeginsWith": {
"description": "An optional string to filter events for an event subscription based on a resource path prefix.\r\nThe format of this depends on the publisher of the events. \r\nWildcard characters are not supported in this path.",
"type": "string"
},
"subjectEndsWith": {
"description": "An optional string to filter events for an event subscription based on a resource path suffix.\r\nWildcard characters are not supported in this path.",
"type": "string"
}
},
"type": "object"
},
"EventSubscriptionFullUrl": {
"description": "Full endpoint url of an event subscription",
"properties": {
"endpointUrl": {
"description": "The URL that represents the endpoint of the destination of an event subscription.",
"type": "string"
}
},
"type": "object"
},
"EventSubscriptionProperties": {
"description": "Properties of the Event Subscription",
"properties": {
"deadLetterDestination": {
"$ref": "#/definitions/DeadLetterDestination",
"description": "The DeadLetter destination of the event subscription."
},
"destination": {
"$ref": "#/definitions/EventSubscriptionDestination",
"description": "Information about the destination where events have to be delivered for the event subscription."
},
"expirationTimeUtc": {
"description": "Expiration time of the event subscription.",
"format": "date-time",
"type": "string"
},
"filter": {
"$ref": "#/definitions/EventSubscriptionFilter",
"description": "Information about the filter for the event subscription."
},
"labels": {
"description": "List of user defined labels.",
"items": {
"type": "string"
},
"type": "array"
},
"provisioningState": {
"description": "Provisioning state of the event subscription.",
"enum": [
"Creating",
"Updating",
"Deleting",
"Succeeded",
"Canceled",
"Failed",
"AwaitingManualAction"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "EventSubscriptionProvisioningState"
}
},
"retryPolicy": {
"$ref": "#/definitions/RetryPolicy",
"description": "The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events."
},
"topic": {
"description": "Name of the topic of the event subscription.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"EventSubscriptionUpdateParameters": {
"description": "Properties of the Event Subscription update",
"properties": {
"deadLetterDestination": {
"$ref": "#/definitions/DeadLetterDestination",
"description": "The DeadLetter destination of the event subscription."
},
"destination": {
"$ref": "#/definitions/EventSubscriptionDestination",
"description": "Information about the destination where events have to be delivered for the event subscription."
},
"expirationTimeUtc": {
"description": "Information about the expiration time for the event subscription.",
"format": "date-time",
"type": "string"
},
"filter": {
"$ref": "#/definitions/EventSubscriptionFilter",
"description": "Information about the filter for the event subscription."
},
"labels": {
"description": "List of user defined labels.",
"items": {
"type": "string"
},
"type": "array"
},
"retryPolicy": {
"$ref": "#/definitions/RetryPolicy",
"description": "The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events."
}
},
"type": "object"
},
"EventSubscriptionsListResult": {
"description": "Result of the List EventSubscriptions operation",
"properties": {
"nextLink": {
"description": "A link for the next page of event subscriptions",
"type": "string"
},
"value": {
"description": "A collection of EventSubscriptions",
"items": {
"$ref": "#/definitions/EventSubscription"
},
"type": "array"
}
},
"type": "object"
},
"EventType": {
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"description": "Event Type for a subject under a topic",
"properties": {
"properties": {
"$ref": "#/definitions/EventTypeProperties",
"description": "Properties of the event type.",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"EventTypeProperties": {
"description": "Properties of the event type",
"properties": {
"description": {
"description": "Description of the event type.",
"type": "string"
},
"displayName": {
"description": "Display name of the event type.",
"type": "string"
},
"isInDefaultSet": {
"description": "IsInDefaultSet flag of the event type.",
"type": "boolean"
},
"schemaUrl": {
"description": "Url of the schema for this event type.",
"type": "string"
}
},
"type": "object"
},
"EventTypesListResult": {
"description": "Result of the List Event Types operation",
"properties": {
"value": {
"description": "A collection of event types",
"items": {
"$ref": "#/definitions/EventType"
},
"type": "array"
}
},
"type": "object"
},
"HybridConnectionEventSubscriptionDestination": {
"allOf": [
{
"$ref": "#/definitions/EventSubscriptionDestination"
}
],
"description": "Information about the HybridConnection destination for an event subscription.",
"properties": {
"properties": {
"$ref": "#/definitions/HybridConnectionEventSubscriptionDestinationProperties",
"description": "Hybrid connection Properties of the event subscription destination",
"x-ms-client-flatten": true
}
},
"type": "object",
"x-ms-discriminator-value": "HybridConnection"
},
"HybridConnectionEventSubscriptionDestinationProperties": {
"description": "The properties for a hybrid connection destination.",
"properties": {
"resourceId": {
"description": "The Azure Resource ID of an hybrid connection that is the destination of an event subscription.",
"type": "string"
}
},
"type": "object"
},
"NumberGreaterThanAdvancedFilter": {
"allOf": [
{
"$ref": "#/definitions/AdvancedFilter"
}
],
"description": "NumberGreaterThan Advanced Filter.",
"properties": {
"value": {
"description": "The filter value.",
"format": "double",
"type": "number"
}
},
"type": "object",
"x-ms-discriminator-value": "NumberGreaterThan"
},
"NumberGreaterThanOrEqualsAdvancedFilter": {
"allOf": [
{
"$ref": "#/definitions/AdvancedFilter"
}
],
"description": "NumberGreaterThanOrEquals Advanced Filter.",
"properties": {
"value": {
"description": "The filter value.",
"format": "double",
"type": "number"
}
},
"type": "object",
"x-ms-discriminator-value": "NumberGreaterThanOrEquals"
},
"NumberInAdvancedFilter": {
"allOf": [
{
"$ref": "#/definitions/AdvancedFilter"
}
],
"description": "NumberIn Advanced Filter.",
"properties": {
"values": {
"description": "The set of filter values.",
"items": {
"format": "double",
"type": "number"
},
"type": "array"
}
},
"type": "object",
"x-ms-discriminator-value": "NumberIn"
},
"NumberLessThanAdvancedFilter": {
"allOf": [
{
"$ref": "#/definitions/AdvancedFilter"
}
],
"description": "NumberLessThan Advanced Filter.",
"properties": {
"value": {
"description": "The filter value.",
"format": "double",
"type": "number"
}
},
"type": "object",
"x-ms-discriminator-value": "NumberLessThan"
},
"NumberLessThanOrEqualsAdvancedFilter": {
"allOf": [
{
"$ref": "#/definitions/AdvancedFilter"
}
],
"description": "NumberLessThanOrEquals Advanced Filter.",
"properties": {
"value": {
"description": "The filter value.",
"format": "double",
"type": "number"
}
},
"type": "object",
"x-ms-discriminator-value": "NumberLessThanOrEquals"
},
"NumberNotInAdvancedFilter": {
"allOf": [
{
"$ref": "#/definitions/AdvancedFilter"
}
],
"description": "NumberNotIn Advanced Filter.",
"properties": {
"values": {
"description": "The set of filter values.",
"items": {
"format": "double",
"type": "number"
},
"type": "array"
}
},
"type": "object",
"x-ms-discriminator-value": "NumberNotIn"
},
"Operation": {
"description": "Represents an operation returned by the GetOperations request",
"properties": {
"display": {
"$ref": "#/definitions/OperationInfo",
"description": "Display name of the operation"
},
"name": {
"description": "Name of the operation",
"type": "string"
},
"origin": {
"description": "Origin of the operation",
"type": "string"
},
"properties": {
"description": "Properties of the operation",
"type": "object",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"OperationInfo": {
"description": "Information about an operation",
"properties": {
"description": {
"description": "Description of the operation",
"type": "string"
},
"operation": {
"description": "Name of the operation",
"type": "string"
},
"provider": {
"description": "Name of the provider",
"type": "string"
},
"resource": {
"description": "Name of the resource type",
"type": "string"
}
},
"type": "object"
},
"OperationsListResult": {
"description": "Result of the List Operations operation",
"properties": {
"value": {
"description": "A collection of operations",
"items": {
"$ref": "#/definitions/Operation"
},
"type": "array"
}
},
"type": "object"
},
"Resource": {
"description": "Definition of a Resource.",
"properties": {
"id": {
"description": "Fully qualified identifier of the resource.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of the resource.",
"readOnly": true,
"type": "string"
}
},
"type": "object",
"x-ms-azure-resource": true
},
"RetryPolicy": {
"description": "Information about the retry policy for an event subscription.",
"properties": {
"eventTimeToLiveInMinutes": {
"description": "Time To Live (in minutes) for events.",
"format": "int32",
"type": "integer"
},
"maxDeliveryAttempts": {
"description": "Maximum number of delivery retry attempts for events.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ServiceBusQueueEventSubscriptionDestination": {
"allOf": [
{
"$ref": "#/definitions/EventSubscriptionDestination"
}
],
"description": "Information about the service bus destination for an event subscription",
"properties": {
"properties": {
"$ref": "#/definitions/ServiceBusQueueEventSubscriptionDestinationProperties",
"description": "Service Bus Properties of the event subscription destination",
"x-ms-client-flatten": true
}
},
"type": "object",
"x-ms-discriminator-value": "ServiceBusQueue"
},
"ServiceBusQueueEventSubscriptionDestinationProperties": {
"description": "The properties that represent the Service Bus destination of an event subscription.",
"properties": {
"resourceId": {
"description": "The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription.",
"type": "string"
}
},
"type": "object"
},
"StorageBlobDeadLetterDestination": {
"allOf": [
{
"$ref": "#/definitions/DeadLetterDestination"
}
],
"description": "Information about the storage blob based dead letter destination.",
"properties": {
"properties": {
"$ref": "#/definitions/StorageBlobDeadLetterDestinationProperties",
"description": "The properties of the Storage Blob based deadletter destination",
"x-ms-client-flatten": true
}
},
"type": "object",
"x-ms-discriminator-value": "StorageBlob"
},
"StorageBlobDeadLetterDestinationProperties": {
"description": "Properties of the storage blob based dead letter destination.",
"properties": {
"blobContainerName": {
"description": "The name of the Storage blob container that is the destination of the deadletter events",
"type": "string"
},
"resourceId": {
"description": "The Azure Resource ID of the storage account that is the destination of the deadletter events",
"type": "string"
}
},
"type": "object"
},
"StorageQueueEventSubscriptionDestination": {
"allOf": [
{
"$ref": "#/definitions/EventSubscriptionDestination"
}
],
"description": "Information about the storage queue destination for an event subscription.",
"properties": {
"properties": {
"$ref": "#/definitions/StorageQueueEventSubscriptionDestinationProperties",
"description": "Storage Queue Properties of the event subscription destination",
"x-ms-client-flatten": true
}
},
"type": "object",
"x-ms-discriminator-value": "StorageQueue"
},
"StorageQueueEventSubscriptionDestinationProperties": {
"description": "The properties for a storage queue destination.",
"properties": {
"queueName": {
"description": "The name of the Storage queue under a storage account that is the destination of an event subscription.",
"type": "string"
},
"resourceId": {
"description": "The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.",
"type": "string"
}
},
"type": "object"
},
"StringBeginsWithAdvancedFilter": {
"allOf": [
{
"$ref": "#/definitions/AdvancedFilter"
}
],
"description": "StringBeginsWith Advanced Filter.",
"properties": {
"values": {
"description": "The set of filter values.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"x-ms-discriminator-value": "StringBeginsWith"
},
"StringContainsAdvancedFilter": {
"allOf": [
{
"$ref": "#/definitions/AdvancedFilter"
}
],
"description": "StringContains Advanced Filter.",
"properties": {
"values": {
"description": "The set of filter values.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"x-ms-discriminator-value": "StringContains"
},
"StringEndsWithAdvancedFilter": {
"allOf": [
{
"$ref": "#/definitions/AdvancedFilter"
}
],
"description": "StringEndsWith Advanced Filter.",
"properties": {
"values": {
"description": "The set of filter values.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"x-ms-discriminator-value": "StringEndsWith"
},
"StringInAdvancedFilter": {
"allOf": [
{
"$ref": "#/definitions/AdvancedFilter"
}
],
"description": "StringIn Advanced Filter.",
"properties": {
"values": {
"description": "The set of filter values.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"x-ms-discriminator-value": "StringIn"
},
"StringNotInAdvancedFilter": {
"allOf": [
{
"$ref": "#/definitions/AdvancedFilter"
}
],
"description": "StringNotIn Advanced Filter.",
"properties": {
"values": {
"description": "The set of filter values.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"x-ms-discriminator-value": "StringNotIn"
},
"Topic": {
"allOf": [
{
"$ref": "#/definitions/TrackedResource"
}
],
"description": "EventGrid Topic",
"properties": {
"properties": {
"$ref": "#/definitions/TopicProperties",
"description": "Properties of the topic",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"TopicProperties": {
"description": "Properties of the Topic",
"properties": {
"endpoint": {
"description": "Endpoint for the topic.",
"readOnly": true,
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the topic.",
"enum": [
"Creating",
"Updating",
"Deleting",
"Succeeded",
"Canceled",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "TopicProvisioningState"
}
}
},
"type": "object"
},
"TopicRegenerateKeyRequest": {
"description": "Topic regenerate share access key request",
"properties": {
"keyName": {
"description": "Key name to regenerate key1 or key2",
"type": "string"
}
},
"required": [
"keyName"
],
"type": "object"
},
"TopicSharedAccessKeys": {
"description": "Shared access keys of the Topic",
"properties": {
"key1": {
"description": "Shared access key1 for the topic.",
"type": "string"
},
"key2": {
"description": "Shared access key2 for the topic.",
"type": "string"
}
},
"type": "object"
},
"TopicTypeInfo": {
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"description": "Properties of a topic type info.",
"properties": {
"properties": {
"$ref": "#/definitions/TopicTypeProperties",
"description": "Properties of the topic type info",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"TopicTypeProperties": {
"description": "Properties of a topic type.",
"properties": {
"description": {
"description": "Description of the topic type.",
"type": "string"
},
"displayName": {
"description": "Display Name for the topic type.",
"type": "string"
},
"provider": {
"description": "Namespace of the provider of the topic type.",
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the topic type",
"enum": [
"Creating",
"Updating",
"Deleting",
"Succeeded",
"Canceled",
"Failed"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "TopicTypeProvisioningState"
}
},
"resourceRegionType": {
"description": "Region type of the resource.",
"enum": [
"RegionalResource",
"GlobalResource"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ResourceRegionType"
}
},
"supportedLocations": {
"description": "List of locations supported by this topic type.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TopicTypesListResult": {
"description": "Result of the List Topic Types operation",
"properties": {
"value": {
"description": "A collection of topic types",
"items": {
"$ref": "#/definitions/TopicTypeInfo"
},
"type": "array"
}
},
"type": "object"
},
"TopicUpdateParameters": {
"description": "Properties of the Topic update",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Tags of the resource",
"type": "object"
}
},
"type": "object"
},
"TopicsListResult": {
"description": "Result of the List Topics operation",
"properties": {
"nextLink": {
"description": "A link for the next page of topics",
"type": "string"
},
"value": {
"description": "A collection of Topics",
"items": {
"$ref": "#/definitions/Topic"
},
"type": "array"
}
},
"type": "object"
},
"TrackedResource": {
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"description": "Definition of a Tracked Resource.",
"properties": {
"location": {
"description": "Location of the resource.",
"type": "string",
"x-ms-mutability": [
"read",
"create"
]
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Tags of the resource.",
"type": "object"
}
},
"required": [
"location"
],
"type": "object"
},
"WebHookEventSubscriptionDestination": {
"allOf": [
{
"$ref": "#/definitions/EventSubscriptionDestination"
}
],
"description": "Information about the webhook destination for an event subscription",
"properties": {
"properties": {
"$ref": "#/definitions/WebHookEventSubscriptionDestinationProperties",
"description": "WebHook Properties of the event subscription destination",
"x-ms-client-flatten": true
}
},
"type": "object",
"x-ms-discriminator-value": "WebHook"
},
"WebHookEventSubscriptionDestinationProperties": {
"description": "Information about the webhook destination properties for an event subscription.",
"properties": {
"endpointBaseUrl": {
"description": "The base URL that represents the endpoint of the destination of an event subscription.",
"readOnly": true,
"type": "string"
},
"endpointUrl": {
"description": "The URL that represents the endpoint of the destination of an event subscription.",
"type": "string"
}
},
"type": "object"
}
}
}