diff --git a/App_Data/SwaggerSpecs/Microsoft.EventGrid/EventGrid.json b/App_Data/SwaggerSpecs/Microsoft.EventGrid/EventGrid.json
index 6ad50467..21da46e7 100644
--- a/App_Data/SwaggerSpecs/Microsoft.EventGrid/EventGrid.json
+++ b/App_Data/SwaggerSpecs/Microsoft.EventGrid/EventGrid.json
@@ -1,7 +1,7 @@
{
"swagger": "2.0",
"info": {
- "version": "2019-06-01",
+ "version": "2021-10-15-preview",
"title": "EventGridManagementClient",
"description": "Azure EventGrid Management Client"
},
@@ -16,14 +16,14 @@
"application/json"
],
"paths": {
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}": {
"get": {
"tags": [
- "Domains"
+ "Channels"
],
- "summary": "Get a domain.",
- "description": "Get properties of a domain.",
- "operationId": "Domains_Get",
+ "summary": "Get a channel.",
+ "description": "Get properties of a channel.",
+ "operationId": "Channels_Get",
"consumes": [],
"produces": [
"application/json"
@@ -35,14 +35,21 @@
{
"name": "resourceGroupName",
"in": "path",
- "description": "The name of the resource group within the user's subscription.",
+ "description": "The name of the resource group within the partners subscription.",
"required": true,
"type": "string"
},
{
- "name": "domainName",
+ "name": "partnerNamespaceName",
"in": "path",
- "description": "Name of the domain.",
+ "description": "Name of the partner namespace.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "channelName",
+ "in": "path",
+ "description": "Name of the channel.",
"required": true,
"type": "string"
},
@@ -54,7 +61,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/Domain"
+ "$ref": "#/definitions/Channel"
}
},
"default": {
@@ -62,18 +69,18 @@
}
},
"x-ms-examples": {
- "Domains_Get": {
- "$ref": "./examples/Domains_Get.json"
+ "Channels_Get": {
+ "$ref": "./examples/Channels_Get.json"
}
}
},
"put": {
"tags": [
- "Domains"
+ "Channels"
],
- "summary": "Create or update a domain.",
- "description": "Asynchronously creates or updates a new domain with the specified parameters.",
- "operationId": "Domains_CreateOrUpdate",
+ "summary": "Create or update a channel.",
+ "description": "Synchronously creates or updates a new channel with the specified parameters.",
+ "operationId": "Channels_CreateOrUpdate",
"consumes": [
"application/json"
],
@@ -87,24 +94,31 @@
{
"name": "resourceGroupName",
"in": "path",
- "description": "The name of the resource group within the user's subscription.",
+ "description": "The name of the resource group within the partners subscription.",
"required": true,
"type": "string"
},
{
- "name": "domainName",
+ "name": "partnerNamespaceName",
"in": "path",
- "description": "Name of the domain.",
+ "description": "Name of the partner namespace.",
"required": true,
"type": "string"
},
{
- "name": "domainInfo",
+ "name": "channelName",
+ "in": "path",
+ "description": "Name of the channel.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "channelInfo",
"in": "body",
- "description": "Domain information.",
+ "description": "Channel information.",
"required": true,
"schema": {
- "$ref": "#/definitions/Domain"
+ "$ref": "#/definitions/Channel"
}
},
{
@@ -112,10 +126,16 @@
}
],
"responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Channel"
+ }
+ },
"201": {
"description": "Created",
"schema": {
- "$ref": "#/definitions/Domain"
+ "$ref": "#/definitions/Channel"
}
},
"default": {
@@ -123,19 +143,18 @@
}
},
"x-ms-examples": {
- "Domains_CreateOrUpdate": {
- "$ref": "./examples/Domains_CreateOrUpdate.json"
+ "Channels_CreateOrUpdate": {
+ "$ref": "./examples/Channels_CreateOrUpdate.json"
}
- },
- "x-ms-long-running-operation": true
+ }
},
"delete": {
"tags": [
- "Domains"
+ "Channels"
],
- "summary": "Delete a domain.",
- "description": "Delete existing domain.",
- "operationId": "Domains_Delete",
+ "summary": "Delete a channel.",
+ "description": "Delete an existing channel.",
+ "operationId": "Channels_Delete",
"consumes": [],
"produces": [
"application/json"
@@ -147,14 +166,21 @@
{
"name": "resourceGroupName",
"in": "path",
- "description": "The name of the resource group within the user's subscription.",
+ "description": "The name of the resource group within the partners subscription.",
"required": true,
"type": "string"
},
{
- "name": "domainName",
+ "name": "partnerNamespaceName",
"in": "path",
- "description": "Name of the domain.",
+ "description": "Name of the partner namespace.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "channelName",
+ "in": "path",
+ "description": "Name of the channel.",
"required": true,
"type": "string"
},
@@ -163,6 +189,9 @@
}
],
"responses": {
+ "200": {
+ "description": "OK"
+ },
"202": {
"description": "Accepted"
},
@@ -174,19 +203,19 @@
}
},
"x-ms-examples": {
- "Domains_Delete": {
- "$ref": "./examples/Domains_Delete.json"
+ "Channels_Delete": {
+ "$ref": "./examples/Channels_Delete.json"
}
},
"x-ms-long-running-operation": true
},
"patch": {
"tags": [
- "Domains"
+ "Channels"
],
- "summary": "Update a domain.",
- "description": "Asynchronously updates a domain with the specified parameters.",
- "operationId": "Domains_Update",
+ "summary": "Update a Channel.",
+ "description": "Synchronously updates a channel with the specified parameters.",
+ "operationId": "Channels_Update",
"consumes": [
"application/json"
],
@@ -200,24 +229,31 @@
{
"name": "resourceGroupName",
"in": "path",
- "description": "The name of the resource group within the user's subscription.",
+ "description": "The name of the resource group within the partners subscription.",
"required": true,
"type": "string"
},
{
- "name": "domainName",
+ "name": "partnerNamespaceName",
"in": "path",
- "description": "Name of the domain.",
+ "description": "Name of the partner namespace.",
"required": true,
"type": "string"
},
{
- "name": "domainUpdateParameters",
+ "name": "channelName",
+ "in": "path",
+ "description": "Name of the channel.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "channelUpdateParameters",
"in": "body",
- "description": "Domain update information.",
+ "description": "Channel update information.",
"required": true,
"schema": {
- "$ref": "#/definitions/DomainUpdateParameters"
+ "$ref": "#/definitions/ChannelUpdateParameters"
}
},
{
@@ -225,32 +261,28 @@
}
],
"responses": {
- "201": {
- "description": "Domain update request accepted.",
- "schema": {
- "$ref": "#/definitions/Domain"
- }
+ "200": {
+ "description": "OK"
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"x-ms-examples": {
- "Domains_Update": {
- "$ref": "./examples/Domains_Update.json"
+ "Channels_Update": {
+ "$ref": "./examples/Channels_Update.json"
}
- },
- "x-ms-long-running-operation": true
+ }
}
},
- "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/domains": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels": {
"get": {
"tags": [
- "Domains"
+ "Channels"
],
- "summary": "List domains under an Azure subscription.",
- "description": "List all the domains under an Azure subscription.",
- "operationId": "Domains_ListBySubscription",
+ "summary": "List channels.",
+ "description": "List all the channels in a partner namespace.",
+ "operationId": "Channels_ListByPartnerNamespace",
"consumes": [],
"produces": [
"application/json"
@@ -259,6 +291,20 @@
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the partners subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerNamespaceName",
+ "in": "path",
+ "description": "Name of the partner namespace.",
+ "required": true,
+ "type": "string"
+ },
{
"$ref": "#/parameters/ApiVersionParameter"
},
@@ -273,7 +319,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/DomainsListResult"
+ "$ref": "#/definitions/ChannelsListResult"
}
},
"default": {
@@ -281,8 +327,8 @@
}
},
"x-ms-examples": {
- "Domains_ListBySubscription": {
- "$ref": "./examples/Domains_ListBySubscription.json"
+ "Channels_ListByPartnerNamespace": {
+ "$ref": "./examples/Channels_ListByPartnerNamespace.json"
}
},
"x-ms-pageable": {
@@ -290,14 +336,14 @@
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains": {
- "get": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}/getFullUrl": {
+ "post": {
"tags": [
- "Domains"
+ "Channels"
],
- "summary": "List domains under a resource group.",
- "description": "List all the domains under a resource group.",
- "operationId": "Domains_ListByResourceGroup",
+ "summary": "Get full URL of partner destination channel.",
+ "description": "Get the full endpoint URL of a partner destination channel.",
+ "operationId": "Channels_GetFullUrl",
"consumes": [],
"produces": [
"application/json"
@@ -309,25 +355,33 @@
{
"name": "resourceGroupName",
"in": "path",
- "description": "The name of the resource group within the user's subscription.",
+ "description": "The name of the resource group within the partners subscription.",
"required": true,
"type": "string"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "name": "partnerNamespaceName",
+ "in": "path",
+ "description": "Name of the partner namespace.",
+ "required": true,
+ "type": "string"
},
{
- "$ref": "#/parameters/FilterParameter"
+ "name": "channelName",
+ "in": "path",
+ "description": "Name of the Channel.",
+ "required": true,
+ "type": "string"
},
{
- "$ref": "#/parameters/TopParameter"
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/DomainsListResult"
+ "$ref": "#/definitions/EventSubscriptionFullUrl"
}
},
"default": {
@@ -335,23 +389,20 @@
}
},
"x-ms-examples": {
- "Domains_ListByResourceGroup": {
- "$ref": "./examples/Domains_ListByResourceGroup.json"
+ "Channels_GetFullUrl": {
+ "$ref": "./examples/Channels_GetFullUrl.json"
}
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/listKeys": {
- "post": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}": {
+ "get": {
"tags": [
"Domains"
],
- "summary": "List keys for a domain.",
- "description": "List the two keys used to publish to a domain.",
- "operationId": "Domains_ListSharedAccessKeys",
+ "summary": "Get a domain.",
+ "description": "Get properties of a domain.",
+ "operationId": "Domains_Get",
"consumes": [],
"produces": [
"application/json"
@@ -382,7 +433,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/DomainSharedAccessKeys"
+ "$ref": "#/definitions/Domain"
}
},
"default": {
@@ -390,20 +441,18 @@
}
},
"x-ms-examples": {
- "Domains_ListSharedAccessKeys": {
- "$ref": "./examples/Domains_ListSharedAccessKeys.json"
+ "Domains_Get": {
+ "$ref": "./examples/Domains_Get.json"
}
}
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/regenerateKey": {
- "post": {
+ },
+ "put": {
"tags": [
"Domains"
],
- "summary": "Regenerate key for a domain.",
- "description": "Regenerate a shared access key for a domain.",
- "operationId": "Domains_RegenerateKey",
+ "summary": "Create or update a domain.",
+ "description": "Asynchronously creates or updates a new domain with the specified parameters.",
+ "operationId": "Domains_CreateOrUpdate",
"consumes": [
"application/json"
],
@@ -429,12 +478,12 @@
"type": "string"
},
{
- "name": "regenerateKeyRequest",
+ "name": "domainInfo",
"in": "body",
- "description": "Request body to regenerate key.",
+ "description": "Domain information.",
"required": true,
"schema": {
- "$ref": "#/definitions/DomainRegenerateKeyRequest"
+ "$ref": "#/definitions/Domain"
}
},
{
@@ -442,10 +491,10 @@
}
],
"responses": {
- "200": {
- "description": "OK",
+ "201": {
+ "description": "Created",
"schema": {
- "$ref": "#/definitions/DomainSharedAccessKeys"
+ "$ref": "#/definitions/Domain"
}
},
"default": {
@@ -453,20 +502,19 @@
}
},
"x-ms-examples": {
- "Domains_RegenerateKey": {
- "$ref": "./examples/Domains_RegenerateKey.json"
+ "Domains_CreateOrUpdate": {
+ "$ref": "./examples/Domains_CreateOrUpdate.json"
}
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}": {
- "get": {
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
"tags": [
- "DomainTopics"
+ "Domains"
],
- "summary": "Get a domain topic.",
- "description": "Get properties of a domain topic.",
- "operationId": "DomainTopics_Get",
+ "summary": "Delete a domain.",
+ "description": "Delete existing domain.",
+ "operationId": "Domains_Delete",
"consumes": [],
"produces": [
"application/json"
@@ -489,42 +537,41 @@
"required": true,
"type": "string"
},
- {
- "name": "domainTopicName",
- "in": "path",
- "description": "Name of the topic.",
- "required": true,
- "type": "string"
- },
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/DomainTopic"
- }
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "NoContent"
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
}
},
"x-ms-examples": {
- "DomainTopics_Get": {
- "$ref": "./examples/DomainTopics_Get.json"
+ "Domains_Delete": {
+ "$ref": "./examples/Domains_Delete.json"
}
- }
+ },
+ "x-ms-long-running-operation": true
},
- "put": {
+ "patch": {
"tags": [
- "DomainTopics"
+ "Domains"
+ ],
+ "summary": "Update a domain.",
+ "description": "Asynchronously updates a domain with the specified parameters.",
+ "operationId": "Domains_Update",
+ "consumes": [
+ "application/json"
],
- "summary": "Create or update a domain topic.",
- "description": "Asynchronously creates or updates a new domain topic with the specified parameters.",
- "operationId": "DomainTopics_CreateOrUpdate",
- "consumes": [],
"produces": [
"application/json"
],
@@ -547,21 +594,26 @@
"type": "string"
},
{
- "name": "domainTopicName",
- "in": "path",
- "description": "Name of the domain topic.",
+ "name": "domainUpdateParameters",
+ "in": "body",
+ "description": "Domain update information.",
"required": true,
- "type": "string"
+ "schema": {
+ "$ref": "#/definitions/DomainUpdateParameters"
+ }
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
+ "200": {
+ "description": "OK"
+ },
"201": {
- "description": "Created",
+ "description": "Domain update request accepted.",
"schema": {
- "$ref": "#/definitions/DomainTopic"
+ "$ref": "#/definitions/Domain"
}
},
"default": {
@@ -569,19 +621,21 @@
}
},
"x-ms-examples": {
- "DomainTopics_CreateOrUpdate": {
- "$ref": "./examples/DomainTopics_CreateOrUpdate.json"
+ "Domains_Update": {
+ "$ref": "./examples/Domains_Update.json"
}
},
"x-ms-long-running-operation": true
- },
- "delete": {
- "tags": [
- "DomainTopics"
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/domains": {
+ "get": {
+ "tags": [
+ "Domains"
],
- "summary": "Delete a domain topic.",
- "description": "Delete existing domain topic.",
- "operationId": "DomainTopics_Delete",
+ "summary": "List domains under an Azure subscription.",
+ "description": "List all the domains under an Azure subscription.",
+ "operationId": "Domains_ListBySubscription",
"consumes": [],
"produces": [
"application/json"
@@ -591,57 +645,44 @@
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
- "name": "resourceGroupName",
- "in": "path",
- "description": "The name of the resource group within the user's subscription.",
- "required": true,
- "type": "string"
- },
- {
- "name": "domainName",
- "in": "path",
- "description": "Name of the domain.",
- "required": true,
- "type": "string"
+ "$ref": "#/parameters/ApiVersionParameter"
},
{
- "name": "domainTopicName",
- "in": "path",
- "description": "Name of the domain topic.",
- "required": true,
- "type": "string"
+ "$ref": "#/parameters/FilterParameter"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "$ref": "#/parameters/TopParameter"
}
],
"responses": {
- "202": {
- "description": "Accepted"
- },
- "204": {
- "description": "NoContent"
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DomainsListResult"
+ }
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"x-ms-examples": {
- "DomainTopics_Delete": {
- "$ref": "./examples/DomainTopics_Delete.json"
+ "Domains_ListBySubscription": {
+ "$ref": "./examples/Domains_ListBySubscription.json"
}
},
- "x-ms-long-running-operation": true
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains": {
"get": {
"tags": [
- "DomainTopics"
+ "Domains"
],
- "summary": "List domain topics.",
- "description": "List all the topics in a domain.",
- "operationId": "DomainTopics_ListByDomain",
+ "summary": "List domains under a resource group.",
+ "description": "List all the domains under a resource group.",
+ "operationId": "Domains_ListByResourceGroup",
"consumes": [],
"produces": [
"application/json"
@@ -657,13 +698,6 @@
"required": true,
"type": "string"
},
- {
- "name": "domainName",
- "in": "path",
- "description": "Domain name.",
- "required": true,
- "type": "string"
- },
{
"$ref": "#/parameters/ApiVersionParameter"
},
@@ -678,7 +712,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/DomainTopicsListResult"
+ "$ref": "#/definitions/DomainsListResult"
}
},
"default": {
@@ -686,8 +720,8 @@
}
},
"x-ms-examples": {
- "DomainTopics_ListByDomain": {
- "$ref": "./examples/DomainTopics_ListByDomain.json"
+ "Domains_ListByResourceGroup": {
+ "$ref": "./examples/Domains_ListByResourceGroup.json"
}
},
"x-ms-pageable": {
@@ -695,31 +729,33 @@
}
}
},
- "/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}": {
- "get": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/listKeys": {
+ "post": {
"tags": [
- "EventSubscriptions"
+ "Domains"
],
- "summary": "Get an event subscription.",
- "description": "Get properties of an event subscription.",
- "operationId": "EventSubscriptions_Get",
+ "summary": "List keys for a domain.",
+ "description": "List the two keys used to publish to a domain.",
+ "operationId": "Domains_ListSharedAccessKeys",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
- "name": "scope",
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
"in": "path",
- "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.",
+ "description": "The name of the resource group within the user's subscription.",
"required": true,
- "type": "string",
- "x-ms-skip-url-encoding": true
+ "type": "string"
},
{
- "name": "eventSubscriptionName",
+ "name": "domainName",
"in": "path",
- "description": "Name of the event subscription.",
+ "description": "Name of the domain.",
"required": true,
"type": "string"
},
@@ -731,7 +767,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/EventSubscription"
+ "$ref": "#/definitions/DomainSharedAccessKeys"
}
},
"default": {
@@ -739,27 +775,20 @@
}
},
"x-ms-examples": {
- "EventSubscriptions_GetForSubscription": {
- "$ref": "./examples/EventSubscriptions_GetForSubscription.json"
- },
- "EventSubscriptions_GetForResourceGroup": {
- "$ref": "./examples/EventSubscriptions_GetForResourceGroup.json"
- },
- "EventSubscriptions_GetForResource": {
- "$ref": "./examples/EventSubscriptions_GetForResource.json"
- },
- "EventSubscriptions_GetForCustomTopic": {
- "$ref": "./examples/EventSubscriptions_GetForCustomTopic.json"
+ "Domains_ListSharedAccessKeys": {
+ "$ref": "./examples/Domains_ListSharedAccessKeys.json"
}
}
- },
- "put": {
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/regenerateKey": {
+ "post": {
"tags": [
- "EventSubscriptions"
+ "Domains"
],
- "summary": "Create or update an event subscription.",
- "description": "Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.",
- "operationId": "EventSubscriptions_CreateOrUpdate",
+ "summary": "Regenerate key for a domain.",
+ "description": "Regenerate a shared access key for a domain.",
+ "operationId": "Domains_RegenerateKey",
"consumes": [
"application/json"
],
@@ -768,27 +797,29 @@
],
"parameters": [
{
- "name": "scope",
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
"in": "path",
- "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.",
+ "description": "The name of the resource group within the user's subscription.",
"required": true,
- "type": "string",
- "x-ms-skip-url-encoding": true
+ "type": "string"
},
{
- "name": "eventSubscriptionName",
+ "name": "domainName",
"in": "path",
- "description": "Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.",
+ "description": "Name of the domain.",
"required": true,
"type": "string"
},
{
- "name": "eventSubscriptionInfo",
+ "name": "regenerateKeyRequest",
"in": "body",
- "description": "Event subscription properties containing the destination and filter information.",
+ "description": "Request body to regenerate key.",
"required": true,
"schema": {
- "$ref": "#/definitions/EventSubscription"
+ "$ref": "#/definitions/DomainRegenerateKeyRequest"
}
},
{
@@ -796,10 +827,10 @@
}
],
"responses": {
- "201": {
- "description": "EventSubscription CreateOrUpdate request accepted.",
+ "200": {
+ "description": "OK",
"schema": {
- "$ref": "#/definitions/EventSubscription"
+ "$ref": "#/definitions/DomainSharedAccessKeys"
}
},
"default": {
@@ -807,54 +838,46 @@
}
},
"x-ms-examples": {
- "EventSubscriptions_CreateOrUpdateForSubscription": {
- "$ref": "./examples/EventSubscriptions_CreateOrUpdateForSubscription.json"
- },
- "EventSubscriptions_CreateOrUpdateForResourceGroup": {
- "$ref": "./examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json"
- },
- "EventSubscriptions_CreateOrUpdateForResource": {
- "$ref": "./examples/EventSubscriptions_CreateOrUpdateForResource.json"
- },
- "EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination": {
- "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json"
- },
- "EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination": {
- "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json"
- },
- "EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination": {
- "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json"
- },
- "EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination": {
- "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json"
+ "Domains_RegenerateKey": {
+ "$ref": "./examples/Domains_RegenerateKey.json"
}
- },
- "x-ms-long-running-operation": true
- },
- "delete": {
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}": {
+ "get": {
"tags": [
- "EventSubscriptions"
+ "DomainTopics"
],
- "summary": "Delete an event subscription.",
- "description": "Delete an existing event subscription.",
- "operationId": "EventSubscriptions_Delete",
+ "summary": "Get a domain topic.",
+ "description": "Get properties of a domain topic.",
+ "operationId": "DomainTopics_Get",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
- "name": "scope",
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
"in": "path",
- "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.",
+ "description": "The name of the resource group within the user's subscription.",
"required": true,
- "type": "string",
- "x-ms-skip-url-encoding": true
+ "type": "string"
},
{
- "name": "eventSubscriptionName",
+ "name": "domainName",
"in": "path",
- "description": "Name of the event subscription.",
+ "description": "Name of the domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainTopicName",
+ "in": "path",
+ "description": "Name of the topic.",
"required": true,
"type": "string"
},
@@ -864,71 +887,56 @@
],
"responses": {
"200": {
- "description": "OK"
- },
- "202": {
- "description": "Accepted"
- },
- "204": {
- "description": "NoContent"
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DomainTopic"
+ }
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"x-ms-examples": {
- "EventSubscriptions_DeleteForSubscription": {
- "$ref": "./examples/EventSubscriptions_DeleteForSubscription.json"
- },
- "EventSubscriptions_DeleteForResourceGroup": {
- "$ref": "./examples/EventSubscriptions_DeleteForResourceGroup.json"
- },
- "EventSubscriptions_DeleteForResource": {
- "$ref": "./examples/EventSubscriptions_DeleteForResource.json"
- },
- "EventSubscriptions_DeleteForCustomTopic": {
- "$ref": "./examples/EventSubscriptions_DeleteForCustomTopic.json"
+ "DomainTopics_Get": {
+ "$ref": "./examples/DomainTopics_Get.json"
}
- },
- "x-ms-long-running-operation": true
+ }
},
- "patch": {
+ "put": {
"tags": [
- "EventSubscriptions"
- ],
- "summary": "Update an event subscription.",
- "description": "Asynchronously updates an existing event subscription.",
- "operationId": "EventSubscriptions_Update",
- "consumes": [
- "application/json"
+ "DomainTopics"
],
+ "summary": "Create or update a domain topic.",
+ "description": "Asynchronously creates or updates a new domain topic with the specified parameters.",
+ "operationId": "DomainTopics_CreateOrUpdate",
+ "consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
- "name": "scope",
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
"in": "path",
- "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.",
+ "description": "The name of the resource group within the user's subscription.",
"required": true,
- "type": "string",
- "x-ms-skip-url-encoding": true
+ "type": "string"
},
{
- "name": "eventSubscriptionName",
+ "name": "domainName",
"in": "path",
- "description": "Name of the event subscription to be updated.",
+ "description": "Name of the domain.",
"required": true,
"type": "string"
},
{
- "name": "eventSubscriptionUpdateParameters",
- "in": "body",
- "description": "Updated event subscription information.",
+ "name": "domainTopicName",
+ "in": "path",
+ "description": "Name of the domain topic.",
"required": true,
- "schema": {
- "$ref": "#/definitions/EventSubscriptionUpdateParameters"
- }
+ "type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
@@ -936,9 +944,9 @@
],
"responses": {
"201": {
- "description": "EventSubscription update request accepted.",
+ "description": "Created",
"schema": {
- "$ref": "#/definitions/EventSubscription"
+ "$ref": "#/definitions/DomainTopic"
}
},
"default": {
@@ -946,47 +954,45 @@
}
},
"x-ms-examples": {
- "EventSubscriptions_UpdateForSubscription": {
- "$ref": "./examples/EventSubscriptions_UpdateForSubscription.json"
- },
- "EventSubscriptions_UpdateForResourceGroup": {
- "$ref": "./examples/EventSubscriptions_UpdateForResourceGroup.json"
- },
- "EventSubscriptions_UpdateForResource": {
- "$ref": "./examples/EventSubscriptions_UpdateForResource.json"
- },
- "EventSubscriptions_UpdateForCustomTopic": {
- "$ref": "./examples/EventSubscriptions_UpdateForCustomTopic.json"
+ "DomainTopics_CreateOrUpdate": {
+ "$ref": "./examples/DomainTopics_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation": true
- }
- },
- "/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}/getFullUrl": {
- "post": {
+ },
+ "delete": {
"tags": [
- "EventSubscriptions"
+ "DomainTopics"
],
- "summary": "Get full URL of an event subscription.",
- "description": "Get the full endpoint URL for an event subscription.",
- "operationId": "EventSubscriptions_GetFullUrl",
+ "summary": "Delete a domain topic.",
+ "description": "Delete existing domain topic.",
+ "operationId": "DomainTopics_Delete",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
- "name": "scope",
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
"in": "path",
- "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.",
+ "description": "The name of the resource group within the user's subscription.",
"required": true,
- "type": "string",
- "x-ms-skip-url-encoding": true
+ "type": "string"
},
{
- "name": "eventSubscriptionName",
+ "name": "domainName",
"in": "path",
- "description": "Name of the event subscription.",
+ "description": "Name of the domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainTopicName",
+ "in": "path",
+ "description": "Name of the domain topic.",
"required": true,
"type": "string"
},
@@ -996,39 +1002,34 @@
],
"responses": {
"200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/EventSubscriptionFullUrl"
- }
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "NoContent"
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
}
},
"x-ms-examples": {
- "EventSubscriptions_GetFullUrlForSubscription": {
- "$ref": "./examples/EventSubscriptions_GetFullUrlForSubscription.json"
- },
- "EventSubscriptions_GetFullUrlForResourceGroup": {
- "$ref": "./examples/EventSubscriptions_GetFullUrlForResourceGroup.json"
- },
- "EventSubscriptions_GetFullUrlForResource": {
- "$ref": "./examples/EventSubscriptions_GetFullUrlForResource.json"
- },
- "EventSubscriptions_GetFullUrlForCustomTopic": {
- "$ref": "./examples/EventSubscriptions_GetFullUrlForCustomTopic.json"
+ "DomainTopics_Delete": {
+ "$ref": "./examples/DomainTopics_Delete.json"
}
- }
+ },
+ "x-ms-long-running-operation": true
}
},
- "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/eventSubscriptions": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics": {
"get": {
"tags": [
- "EventSubscriptions"
+ "DomainTopics"
],
- "summary": "Get an aggregated list of all global event subscriptions under an Azure subscription.",
- "description": "List all aggregated global event subscriptions under a specific Azure subscription.",
- "operationId": "EventSubscriptions_ListGlobalBySubscription",
+ "summary": "List domain topics.",
+ "description": "List all the topics in a domain.",
+ "operationId": "DomainTopics_ListByDomain",
"consumes": [],
"produces": [
"application/json"
@@ -1037,6 +1038,20 @@
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Domain name.",
+ "required": true,
+ "type": "string"
+ },
{
"$ref": "#/parameters/ApiVersionParameter"
},
@@ -1051,31 +1066,31 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/EventSubscriptionsListResult"
+ "$ref": "#/definitions/DomainTopicsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
"x-ms-examples": {
- "EventSubscriptions_ListGlobalBySubscription": {
- "$ref": "./examples/EventSubscriptions_ListGlobalBySubscription.json"
+ "DomainTopics_ListByDomain": {
+ "$ref": "./examples/DomainTopics_ListByDomain.json"
}
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
}
}
},
- "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/eventChannels/{eventChannelName}": {
"get": {
"tags": [
- "EventSubscriptions"
+ "EventChannels"
],
- "summary": "List all global event subscriptions for a topic type.",
- "description": "List all global event subscriptions under an Azure subscription for a topic type.",
- "operationId": "EventSubscriptions_ListGlobalBySubscriptionForTopicType",
+ "summary": "Get an event channel.",
+ "description": "Get properties of an event channel.",
+ "operationId": "EventChannels_Get",
"consumes": [],
"produces": [
"application/json"
@@ -1085,52 +1100,57 @@
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
- "name": "topicTypeName",
+ "name": "resourceGroupName",
"in": "path",
- "description": "Name of the topic type.",
+ "description": "The name of the resource group within the user's subscription.",
"required": true,
"type": "string"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "name": "partnerNamespaceName",
+ "in": "path",
+ "description": "Name of the partner namespace.",
+ "required": true,
+ "type": "string"
},
{
- "$ref": "#/parameters/FilterParameter"
+ "name": "eventChannelName",
+ "in": "path",
+ "description": "Name of the event channel.",
+ "required": true,
+ "type": "string"
},
{
- "$ref": "#/parameters/TopParameter"
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/EventSubscriptionsListResult"
+ "$ref": "#/definitions/EventChannel"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
"x-ms-examples": {
- "EventSubscriptions_ListGlobalBySubscriptionForTopicType": {
- "$ref": "./examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json"
+ "EventChannels_Get": {
+ "$ref": "./examples/EventChannels_Get.json"
}
}
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/eventSubscriptions": {
- "get": {
+ },
+ "put": {
"tags": [
- "EventSubscriptions"
+ "EventChannels"
+ ],
+ "summary": "Create an event channel.",
+ "description": "Asynchronously creates a new event channel with the specified parameters.",
+ "operationId": "EventChannels_CreateOrUpdate",
+ "consumes": [
+ "application/json"
],
- "summary": "List all global event subscriptions under an Azure subscription and resource group.",
- "description": "List all global event subscriptions under a specific Azure subscription and resource group.",
- "operationId": "EventSubscriptions_ListGlobalByResourceGroup",
- "consumes": [],
"produces": [
"application/json"
],
@@ -1146,44 +1166,56 @@
"type": "string"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "name": "partnerNamespaceName",
+ "in": "path",
+ "description": "Name of the partner namespace.",
+ "required": true,
+ "type": "string"
},
{
- "$ref": "#/parameters/FilterParameter"
+ "name": "eventChannelName",
+ "in": "path",
+ "description": "Name of the event channel.",
+ "required": true,
+ "type": "string"
},
{
- "$ref": "#/parameters/TopParameter"
+ "name": "eventChannelInfo",
+ "in": "body",
+ "description": "EventChannel information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/EventChannel"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/EventSubscriptionsListResult"
+ "$ref": "#/definitions/EventChannel"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
"x-ms-examples": {
- "EventSubscriptions_ListGlobalByResourceGroup": {
- "$ref": "./examples/EventSubscriptions_ListGlobalByResourceGroup.json"
+ "EventChannels_CreateOrUpdate": {
+ "$ref": "./examples/EventChannels_CreateOrUpdate.json"
}
}
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions": {
- "get": {
+ },
+ "delete": {
"tags": [
- "EventSubscriptions"
+ "EventChannels"
],
- "summary": "List all global event subscriptions under a resource group for a topic type.",
- "description": "List all global event subscriptions under a resource group for a specific topic type.",
- "operationId": "EventSubscriptions_ListGlobalByResourceGroupForTopicType",
+ "summary": "Delete an event channel.",
+ "description": "Delete existing event channel.",
+ "operationId": "EventChannels_Delete",
"consumes": [],
"produces": [
"application/json"
@@ -1200,51 +1232,53 @@
"type": "string"
},
{
- "name": "topicTypeName",
+ "name": "partnerNamespaceName",
"in": "path",
- "description": "Name of the topic type.",
+ "description": "Name of the partner namespace.",
"required": true,
"type": "string"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/FilterParameter"
+ "name": "eventChannelName",
+ "in": "path",
+ "description": "Name of the event channel.",
+ "required": true,
+ "type": "string"
},
{
- "$ref": "#/parameters/TopParameter"
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/EventSubscriptionsListResult"
- }
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "NoContent"
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
}
},
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
"x-ms-examples": {
- "EventSubscriptions_ListGlobalByResourceGroupForTopicType": {
- "$ref": "./examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json"
+ "EventChannels_Delete": {
+ "$ref": "./examples/EventChannels_Delete.json"
}
- }
+ },
+ "x-ms-long-running-operation": true
}
},
- "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/eventChannels": {
"get": {
"tags": [
- "EventSubscriptions"
+ "EventChannels"
],
- "summary": "List all regional event subscriptions under an Azure subscription.",
- "description": "List all event subscriptions from the given location under a specific Azure subscription.",
- "operationId": "EventSubscriptions_ListRegionalBySubscription",
+ "summary": "List event channels.",
+ "description": "List all the event channels in a partner namespace.",
+ "operationId": "EventChannels_ListByPartnerNamespace",
"consumes": [],
"produces": [
"application/json"
@@ -1254,9 +1288,16 @@
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
- "name": "location",
+ "name": "resourceGroupName",
"in": "path",
- "description": "Name of the location.",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerNamespaceName",
+ "in": "path",
+ "description": "Name of the partner namespace.",
"required": true,
"type": "string"
},
@@ -1274,272 +1315,300 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/EventSubscriptionsListResult"
+ "$ref": "#/definitions/EventChannelsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
"x-ms-examples": {
- "EventSubscriptions_ListRegionalBySubscription": {
- "$ref": "./examples/EventSubscriptions_ListRegionalBySubscription.json"
+ "EventChannels_ListByPartnerNamespace": {
+ "$ref": "./examples/EventChannels_ListByPartnerNamespace.json"
}
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions": {
+ "/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}": {
"get": {
"tags": [
"EventSubscriptions"
],
- "summary": "List all regional event subscriptions under an Azure subscription and resource group.",
- "description": "List all event subscriptions from the given location under a specific Azure subscription and resource group.",
- "operationId": "EventSubscriptions_ListRegionalByResourceGroup",
+ "summary": "Get an event subscription.",
+ "description": "Get properties of an event subscription.",
+ "operationId": "EventSubscriptions_Get",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
- "$ref": "#/parameters/SubscriptionIdParameter"
- },
- {
- "name": "resourceGroupName",
+ "name": "scope",
"in": "path",
- "description": "The name of the resource group within the user's subscription.",
+ "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.",
"required": true,
- "type": "string"
+ "type": "string",
+ "x-ms-skip-url-encoding": true
},
{
- "name": "location",
+ "name": "eventSubscriptionName",
"in": "path",
- "description": "Name of the location.",
+ "description": "Name of the event subscription.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/FilterParameter"
- },
- {
- "$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/EventSubscriptionsListResult"
+ "$ref": "#/definitions/EventSubscription"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
"x-ms-examples": {
- "EventSubscriptions_ListRegionalByResourceGroup": {
- "$ref": "./examples/EventSubscriptions_ListRegionalByResourceGroup.json"
+ "EventSubscriptions_GetForSubscription": {
+ "$ref": "./examples/EventSubscriptions_GetForSubscription.json"
+ },
+ "EventSubscriptions_GetForResourceGroup": {
+ "$ref": "./examples/EventSubscriptions_GetForResourceGroup.json"
+ },
+ "EventSubscriptions_GetForResource": {
+ "$ref": "./examples/EventSubscriptions_GetForResource.json"
+ },
+ "EventSubscriptions_GetForCustomTopic": {
+ "$ref": "./examples/EventSubscriptions_GetForCustomTopic.json"
+ },
+ "EventSubscriptions_GetForCustomTopic_WebhookDestination": {
+ "$ref": "./examples/EventSubscriptions_GetForCustomTopic_WebhookDestination.json"
+ },
+ "EventSubscriptions_GetForCustomTopic_EventHubDestination": {
+ "$ref": "./examples/EventSubscriptions_GetForCustomTopic_EventHubDestination.json"
+ },
+ "EventSubscriptions_GetForCustomTopic_HybridConnectionDestination": {
+ "$ref": "./examples/EventSubscriptions_GetForCustomTopic_HybridConnectionDestination.json"
+ },
+ "EventSubscriptions_GetForCustomTopic_StorageQueueDestination": {
+ "$ref": "./examples/EventSubscriptions_GetForCustomTopic_StorageQueueDestination.json"
+ },
+ "EventSubscriptions_GetForCustomTopic_AzureFunctionDestination": {
+ "$ref": "./examples/EventSubscriptions_GetForCustomTopic_AzureFunctionDestination.json"
+ },
+ "EventSubscriptions_GetForCustomTopic_ServiceBusTopicDestination": {
+ "$ref": "./examples/EventSubscriptions_GetForCustomTopic_ServiceBusTopicDestination.json"
+ },
+ "EventSubscriptions_GetForCustomTopic_ServiceBusQueueDestination": {
+ "$ref": "./examples/EventSubscriptions_GetForCustomTopic_ServiceBusQueueDestination.json"
}
}
- }
- },
- "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions": {
- "get": {
+ },
+ "put": {
"tags": [
"EventSubscriptions"
],
- "summary": "List all regional event subscriptions under an Azure subscription for a topic type.",
- "description": "List all event subscriptions from the given location under a specific Azure subscription and topic type.",
- "operationId": "EventSubscriptions_ListRegionalBySubscriptionForTopicType",
- "consumes": [],
+ "summary": "Create or update an event subscription.",
+ "description": "Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.",
+ "operationId": "EventSubscriptions_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
"produces": [
"application/json"
],
"parameters": [
{
- "$ref": "#/parameters/SubscriptionIdParameter"
- },
- {
- "name": "location",
+ "name": "scope",
"in": "path",
- "description": "Name of the location.",
+ "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.",
"required": true,
- "type": "string"
+ "type": "string",
+ "x-ms-skip-url-encoding": true
},
{
- "name": "topicTypeName",
+ "name": "eventSubscriptionName",
"in": "path",
- "description": "Name of the topic type.",
+ "description": "Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.",
"required": true,
"type": "string"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/FilterParameter"
+ "name": "eventSubscriptionInfo",
+ "in": "body",
+ "description": "Event subscription properties containing the destination and filter information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
+ }
},
{
- "$ref": "#/parameters/TopParameter"
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
- "200": {
- "description": "OK",
+ "201": {
+ "description": "EventSubscription CreateOrUpdate request accepted.",
"schema": {
- "$ref": "#/definitions/EventSubscriptionsListResult"
+ "$ref": "#/definitions/EventSubscription"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
"x-ms-examples": {
- "EventSubscriptions_ListRegionalBySubscriptionForTopicType": {
- "$ref": "./examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json"
+ "EventSubscriptions_CreateOrUpdateForSubscription": {
+ "$ref": "./examples/EventSubscriptions_CreateOrUpdateForSubscription.json"
+ },
+ "EventSubscriptions_CreateOrUpdateForResourceGroup": {
+ "$ref": "./examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json"
+ },
+ "EventSubscriptions_CreateOrUpdateForResource": {
+ "$ref": "./examples/EventSubscriptions_CreateOrUpdateForResource.json"
+ },
+ "EventSubscriptions_CreateOrUpdateForCustomTopic": {
+ "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic.json"
+ },
+ "EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination": {
+ "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json"
+ },
+ "EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination": {
+ "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json"
+ },
+ "EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination": {
+ "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json"
+ },
+ "EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination": {
+ "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json"
+ },
+ "EventSubscriptions_CreateOrUpdateForCustomTopic_AzureFunctionDestination": {
+ "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_AzureFunctionDestination.json"
+ },
+ "EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusTopicDestination": {
+ "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusTopicDestination.json"
+ },
+ "EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusQueueDestination": {
+ "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusQueueDestination.json"
}
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions": {
- "get": {
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
"tags": [
"EventSubscriptions"
],
- "summary": "List all regional event subscriptions under an Azure subscription and resource group for a topic type.",
- "description": "List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.",
- "operationId": "EventSubscriptions_ListRegionalByResourceGroupForTopicType",
+ "summary": "Delete an event subscription.",
+ "description": "Delete an existing event subscription.",
+ "operationId": "EventSubscriptions_Delete",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
- "$ref": "#/parameters/SubscriptionIdParameter"
- },
- {
- "name": "resourceGroupName",
- "in": "path",
- "description": "The name of the resource group within the user's subscription.",
- "required": true,
- "type": "string"
- },
- {
- "name": "location",
+ "name": "scope",
"in": "path",
- "description": "Name of the location.",
+ "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.",
"required": true,
- "type": "string"
+ "type": "string",
+ "x-ms-skip-url-encoding": true
},
{
- "name": "topicTypeName",
+ "name": "eventSubscriptionName",
"in": "path",
- "description": "Name of the topic type.",
+ "description": "Name of the event subscription.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/FilterParameter"
- },
- {
- "$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/EventSubscriptionsListResult"
- }
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "NoContent"
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
}
},
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
"x-ms-examples": {
- "EventSubscriptions_ListRegionalByResourceGroupForTopicType": {
- "$ref": "./examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json"
+ "EventSubscriptions_DeleteForSubscription": {
+ "$ref": "./examples/EventSubscriptions_DeleteForSubscription.json"
+ },
+ "EventSubscriptions_DeleteForResourceGroup": {
+ "$ref": "./examples/EventSubscriptions_DeleteForResourceGroup.json"
+ },
+ "EventSubscriptions_DeleteForResource": {
+ "$ref": "./examples/EventSubscriptions_DeleteForResource.json"
+ },
+ "EventSubscriptions_DeleteForCustomTopic": {
+ "$ref": "./examples/EventSubscriptions_DeleteForCustomTopic.json"
}
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventSubscriptions": {
- "get": {
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
"tags": [
"EventSubscriptions"
],
- "summary": "List all event subscriptions for a specific topic.",
- "description": "List all event subscriptions that have been created for a specific topic.",
- "operationId": "EventSubscriptions_ListByResource",
- "consumes": [],
+ "summary": "Update an event subscription.",
+ "description": "Asynchronously updates an existing event subscription.",
+ "operationId": "EventSubscriptions_Update",
+ "consumes": [
+ "application/json"
+ ],
"produces": [
"application/json"
],
"parameters": [
{
- "$ref": "#/parameters/SubscriptionIdParameter"
- },
- {
- "name": "resourceGroupName",
+ "name": "scope",
"in": "path",
- "description": "The name of the resource group within the user's subscription.",
+ "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.",
"required": true,
- "type": "string"
+ "type": "string",
+ "x-ms-skip-url-encoding": true
},
{
- "name": "providerNamespace",
+ "name": "eventSubscriptionName",
"in": "path",
- "description": "Namespace of the provider of the topic.",
+ "description": "Name of the event subscription to be updated.",
"required": true,
"type": "string"
},
{
- "name": "resourceTypeName",
- "in": "path",
- "description": "Name of the resource type.",
- "required": true,
- "type": "string"
- },
- {
- "name": "resourceName",
- "in": "path",
- "description": "Name of the resource.",
+ "name": "eventSubscriptionUpdateParameters",
+ "in": "body",
+ "description": "Updated event subscription information.",
"required": true,
- "type": "string"
+ "schema": {
+ "$ref": "#/definitions/EventSubscriptionUpdateParameters"
+ }
},
{
"$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/FilterParameter"
- },
- {
- "$ref": "#/parameters/TopParameter"
}
],
"responses": {
- "200": {
- "description": "OK",
+ "201": {
+ "description": "EventSubscription update request accepted.",
"schema": {
- "$ref": "#/definitions/EventSubscriptionsListResult"
+ "$ref": "#/definitions/EventSubscription"
}
},
"default": {
@@ -1547,23 +1616,51 @@
}
},
"x-ms-examples": {
- "EventSubscriptions_ListByResource": {
- "$ref": "./examples/EventSubscriptions_ListByResource.json"
+ "EventSubscriptions_UpdateForSubscription": {
+ "$ref": "./examples/EventSubscriptions_UpdateForSubscription.json"
+ },
+ "EventSubscriptions_UpdateForResourceGroup": {
+ "$ref": "./examples/EventSubscriptions_UpdateForResourceGroup.json"
+ },
+ "EventSubscriptions_UpdateForResource": {
+ "$ref": "./examples/EventSubscriptions_UpdateForResource.json"
+ },
+ "EventSubscriptions_UpdateForCustomTopic": {
+ "$ref": "./examples/EventSubscriptions_UpdateForCustomTopic.json"
+ },
+ "EventSubscriptions_UpdateForCustomTopic_WebhookDestination": {
+ "$ref": "./examples/EventSubscriptions_UpdateForCustomTopic_WebhookDestination.json"
+ },
+ "EventSubscriptions_UpdateForCustomTopic_EventHubDestination": {
+ "$ref": "./examples/EventSubscriptions_UpdateForCustomTopic_EventHubDestination.json"
+ },
+ "EventSubscriptions_UpdateForCustomTopic_HybridConnectionDestination": {
+ "$ref": "./examples/EventSubscriptions_UpdateForCustomTopic_HybridConnectionDestination.json"
+ },
+ "EventSubscriptions_UpdateForCustomTopic_StorageQueueDestination": {
+ "$ref": "./examples/EventSubscriptions_UpdateForCustomTopic_StorageQueueDestination.json"
+ },
+ "EventSubscriptions_UpdateForCustomTopic_AzureFunctionDestination": {
+ "$ref": "./examples/EventSubscriptions_UpdateForCustomTopic_AzureFunctionDestination.json"
+ },
+ "EventSubscriptions_UpdateForCustomTopic_ServiceBusTopicDestination": {
+ "$ref": "./examples/EventSubscriptions_UpdateForCustomTopic_ServiceBusTopicDestination.json"
+ },
+ "EventSubscriptions_UpdateForCustomTopic_ServiceBusQueueDestination": {
+ "$ref": "./examples/EventSubscriptions_UpdateForCustomTopic_ServiceBusQueueDestination.json"
}
},
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
+ "x-ms-long-running-operation": true
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/providers/Microsoft.EventGrid/eventSubscriptions": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}": {
"get": {
"tags": [
"EventSubscriptions"
],
- "summary": "List all event subscriptions for a specific domain topic.",
- "description": "List all event subscriptions that have been created for a specific domain topic.",
- "operationId": "EventSubscriptions_ListByDomainTopic",
+ "summary": "Get a nested event subscription for domain topic.",
+ "description": "Get properties of a nested event subscription for a domain topic.",
+ "operationId": "DomainTopicEventSubscriptions_Get",
"consumes": [],
"produces": [
"application/json"
@@ -1594,20 +1691,21 @@
"type": "string"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/FilterParameter"
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription.",
+ "required": true,
+ "type": "string"
},
{
- "$ref": "#/parameters/TopParameter"
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/EventSubscriptionsListResult"
+ "$ref": "#/definitions/EventSubscription"
}
},
"default": {
@@ -1615,62 +1713,21 @@
}
},
"x-ms-examples": {
- "EventSubscriptions_ListByDomainTopic": {
- "$ref": "./examples/EventSubscriptions_ListByDomainTopic.json"
+ "DomainTopicEventSubscriptions_Get": {
+ "$ref": "./examples/DomainTopicEventSubscriptions_Get.json"
}
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
}
- }
- },
- "/providers/Microsoft.EventGrid/operations": {
- "get": {
+ },
+ "put": {
"tags": [
- "Operations"
+ "EventSubscriptions"
],
- "summary": "List available operations.",
- "description": "List the available operations supported by the Microsoft.EventGrid resource provider.",
- "operationId": "Operations_List",
- "consumes": [],
- "produces": [
+ "summary": "Create or update a nested event subscription to a domain topic.",
+ "description": "Asynchronously creates a new event subscription or updates an existing event subscription.",
+ "operationId": "DomainTopicEventSubscriptions_CreateOrUpdate",
+ "consumes": [
"application/json"
],
- "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."
- }
- },
- "x-ms-pageable": {
- "nextLinkName": null
- },
- "x-ms-examples": {
- "Operations_List": {
- "$ref": "./examples/Operations_List.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}": {
- "get": {
- "tags": [
- "Topics"
- ],
- "summary": "Get a topic.",
- "description": "Get properties of a topic.",
- "operationId": "Topics_Get",
- "consumes": [],
"produces": [
"application/json"
],
@@ -1686,71 +1743,33 @@
"type": "string"
},
{
- "name": "topicName",
+ "name": "domainName",
"in": "path",
- "description": "Name of the topic.",
+ "description": "Name of the top level domain.",
"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."
- }
- },
- "x-ms-examples": {
- "Topics_Get": {
- "$ref": "./examples/Topics_Get.json"
- }
- }
- },
- "put": {
- "tags": [
- "Topics"
- ],
- "summary": "Create a topic.",
- "description": "Asynchronously creates a new topic with the specified parameters.",
- "operationId": "Topics_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- },
- {
- "name": "resourceGroupName",
+ "name": "topicName",
"in": "path",
- "description": "The name of the resource group within the user's subscription.",
+ "description": "Name of the domain topic.",
"required": true,
"type": "string"
},
{
- "name": "topicName",
+ "name": "eventSubscriptionName",
"in": "path",
- "description": "Name of the topic.",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
"required": true,
"type": "string"
},
{
- "name": "topicInfo",
+ "name": "eventSubscriptionInfo",
"in": "body",
- "description": "Topic information.",
+ "description": "Event subscription properties containing the destination and filter information.",
"required": true,
"schema": {
- "$ref": "#/definitions/Topic"
+ "$ref": "#/definitions/EventSubscription"
}
},
{
@@ -1758,10 +1777,16 @@
}
],
"responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
+ }
+ },
"201": {
"description": "Created",
"schema": {
- "$ref": "#/definitions/Topic"
+ "$ref": "#/definitions/EventSubscription"
}
},
"default": {
@@ -1769,19 +1794,19 @@
}
},
"x-ms-examples": {
- "Topics_CreateOrUpdate": {
- "$ref": "./examples/Topics_CreateOrUpdate.json"
+ "DomainTopicEventSubscriptions_CreateOrUpdate": {
+ "$ref": "./examples/DomainTopicEventSubscriptions_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation": true
},
"delete": {
"tags": [
- "Topics"
+ "EventSubscriptions"
],
- "summary": "Delete a topic.",
- "description": "Delete existing topic.",
- "operationId": "Topics_Delete",
+ "summary": "Delete a nested event subscription for a domain topic.",
+ "description": "Delete a nested existing event subscription for a domain topic.",
+ "operationId": "DomainTopicEventSubscriptions_Delete",
"consumes": [],
"produces": [
"application/json"
@@ -1797,10 +1822,24 @@
"required": true,
"type": "string"
},
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the top level domain.",
+ "required": true,
+ "type": "string"
+ },
{
"name": "topicName",
"in": "path",
- "description": "Name of the topic.",
+ "description": "Name of the domain topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
"required": true,
"type": "string"
},
@@ -1809,6 +1848,9 @@
}
],
"responses": {
+ "200": {
+ "description": "OK"
+ },
"202": {
"description": "Accepted"
},
@@ -1820,19 +1862,19 @@
}
},
"x-ms-examples": {
- "Topics_Delete": {
- "$ref": "./examples/Topics_Delete.json"
+ "DomainTopicEventSubscriptions_Delete": {
+ "$ref": "./examples/DomainTopicEventSubscriptions_Delete.json"
}
},
"x-ms-long-running-operation": true
},
"patch": {
"tags": [
- "Topics"
+ "EventSubscriptions"
],
- "summary": "Update a topic.",
- "description": "Asynchronously updates a topic with the specified parameters.",
- "operationId": "Topics_Update",
+ "summary": "Update a nested event subscription for a domain topic.",
+ "description": "Update an existing event subscription for a domain topic.",
+ "operationId": "DomainTopicEventSubscriptions_Update",
"consumes": [
"application/json"
],
@@ -1850,6 +1892,13 @@
"required": true,
"type": "string"
},
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the domain.",
+ "required": true,
+ "type": "string"
+ },
{
"name": "topicName",
"in": "path",
@@ -1858,12 +1907,19 @@
"type": "string"
},
{
- "name": "topicUpdateParameters",
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be updated.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionUpdateParameters",
"in": "body",
- "description": "Topic update information.",
+ "description": "Updated event subscription information.",
"required": true,
"schema": {
- "$ref": "#/definitions/TopicUpdateParameters"
+ "$ref": "#/definitions/EventSubscriptionUpdateParameters"
}
},
{
@@ -1872,9 +1928,9 @@
],
"responses": {
"201": {
- "description": "Topic update request accepted.",
+ "description": "Created",
"schema": {
- "$ref": "#/definitions/Topic"
+ "$ref": "#/definitions/EventSubscription"
}
},
"default": {
@@ -1882,21 +1938,21 @@
}
},
"x-ms-examples": {
- "Topics_Update": {
- "$ref": "./examples/Topics_Update.json"
+ "DomainTopicEventSubscriptions_Update": {
+ "$ref": "./examples/DomainTopicEventSubscriptions_Update.json"
}
},
"x-ms-long-running-operation": true
}
},
- "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}": {
"get": {
"tags": [
- "Topics"
+ "EventSubscriptions"
],
- "summary": "List topics under an Azure subscription.",
- "description": "List all the topics under an Azure subscription.",
- "operationId": "Topics_ListBySubscription",
+ "summary": "Get an event subscription of a topic.",
+ "description": "Get properties of an event subscription of a topic.",
+ "operationId": "TopicEventSubscriptions_Get",
"consumes": [],
"produces": [
"application/json"
@@ -1906,45 +1962,57 @@
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/FilterParameter"
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
},
{
- "$ref": "#/parameters/TopParameter"
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/TopicsListResult"
+ "$ref": "#/definitions/EventSubscription"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
"x-ms-examples": {
- "Topics_ListBySubscription": {
- "$ref": "./examples/Topics_ListBySubscription.json"
+ "TopicEventSubscriptions_Get": {
+ "$ref": "./examples/TopicEventSubscriptions_Get.json"
}
}
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics": {
- "get": {
+ },
+ "put": {
"tags": [
- "Topics"
+ "EventSubscriptions"
+ ],
+ "summary": "Create or update an event subscription to a topic.",
+ "description": "Asynchronously creates a new event subscription or updates an existing event subscription.",
+ "operationId": "TopicEventSubscriptions_CreateOrUpdate",
+ "consumes": [
+ "application/json"
],
- "summary": "List topics under a resource group.",
- "description": "List all the topics under a resource group.",
- "operationId": "Topics_ListByResourceGroup",
- "consumes": [],
"produces": [
"application/json"
],
@@ -1960,44 +2028,63 @@
"type": "string"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the domain topic.",
+ "required": true,
+ "type": "string"
},
{
- "$ref": "#/parameters/FilterParameter"
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "required": true,
+ "type": "string"
},
{
- "$ref": "#/parameters/TopParameter"
+ "name": "eventSubscriptionInfo",
+ "in": "body",
+ "description": "Event subscription properties containing the destination and filter information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/TopicsListResult"
+ "$ref": "#/definitions/EventSubscription"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
"x-ms-examples": {
- "Topics_ListByResourceGroup": {
- "$ref": "./examples/Topics_ListByResourceGroup.json"
+ "TopicEventSubscriptions_CreateOrUpdate": {
+ "$ref": "./examples/TopicEventSubscriptions_CreateOrUpdate.json"
}
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/listKeys": {
- "post": {
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
"tags": [
- "Topics"
+ "EventSubscriptions"
],
- "summary": "List keys for a topic.",
- "description": "List the two keys used to publish to a topic.",
- "operationId": "Topics_ListSharedAccessKeys",
+ "summary": "Delete an event subscription for a topic.",
+ "description": "Delete an existing event subscription for a topic.",
+ "operationId": "TopicEventSubscriptions_Delete",
"consumes": [],
"produces": [
"application/json"
@@ -2020,36 +2107,45 @@
"required": true,
"type": "string"
},
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "required": true,
+ "type": "string"
+ },
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/TopicSharedAccessKeys"
- }
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "NoContent"
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
}
},
"x-ms-examples": {
- "Topics_ListSharedAccessKeys": {
- "$ref": "./examples/Topics_ListSharedAccessKeys.json"
+ "TopicEventSubscriptions_Delete": {
+ "$ref": "./examples/TopicEventSubscriptions_Delete.json"
}
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/regenerateKey": {
- "post": {
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
"tags": [
- "Topics"
+ "EventSubscriptions"
],
- "summary": "Regenerate key for a topic.",
- "description": "Regenerate a shared access key for a topic.",
- "operationId": "Topics_RegenerateKey",
+ "summary": "Update an event subscription for a topic.",
+ "description": "Update an existing event subscription for a topic.",
+ "operationId": "TopicEventSubscriptions_Update",
"consumes": [
"application/json"
],
@@ -2070,17 +2166,24 @@
{
"name": "topicName",
"in": "path",
- "description": "Name of the topic.",
+ "description": "Name of the domain.",
"required": true,
"type": "string"
},
{
- "name": "regenerateKeyRequest",
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be updated.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionUpdateParameters",
"in": "body",
- "description": "Request body to regenerate key.",
+ "description": "Updated event subscription information.",
"required": true,
"schema": {
- "$ref": "#/definitions/TopicRegenerateKeyRequest"
+ "$ref": "#/definitions/EventSubscriptionUpdateParameters"
}
},
{
@@ -2088,10 +2191,10 @@
}
],
"responses": {
- "200": {
- "description": "OK",
+ "201": {
+ "description": "Created",
"schema": {
- "$ref": "#/definitions/TopicSharedAccessKeys"
+ "$ref": "#/definitions/EventSubscription"
}
},
"default": {
@@ -2099,20 +2202,21 @@
}
},
"x-ms-examples": {
- "Topics_RegenerateKey": {
- "$ref": "./examples/Topics_RegenerateKey.json"
+ "TopicEventSubscriptions_Update": {
+ "$ref": "./examples/TopicEventSubscriptions_Update.json"
}
- }
+ },
+ "x-ms-long-running-operation": true
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventTypes": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}": {
"get": {
"tags": [
- "Topics"
+ "EventSubscriptions"
],
- "summary": "List topic event types.",
- "description": "List event types for a topic.",
- "operationId": "Topics_ListEventTypes",
+ "summary": "Get an event subscription of a domain.",
+ "description": "Get properties of an event subscription of a domain.",
+ "operationId": "DomainEventSubscriptions_Get",
"consumes": [],
"produces": [
"application/json"
@@ -2129,23 +2233,16 @@
"type": "string"
},
{
- "name": "providerNamespace",
- "in": "path",
- "description": "Namespace of the provider of the topic.",
- "required": true,
- "type": "string"
- },
- {
- "name": "resourceTypeName",
+ "name": "domainName",
"in": "path",
- "description": "Name of the topic type.",
+ "description": "Name of the partner topic.",
"required": true,
"type": "string"
},
{
- "name": "resourceName",
+ "name": "eventSubscriptionName",
"in": "path",
- "description": "Name of the topic.",
+ "description": "Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
"required": true,
"type": "string"
},
@@ -2157,36 +2254,66 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/EventTypesListResult"
+ "$ref": "#/definitions/EventSubscription"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
- "x-ms-pageable": {
- "nextLinkName": null
- },
"x-ms-examples": {
- "Topics_ListEventTypes": {
- "$ref": "./examples/Topics_ListEventTypes.json"
+ "DomainEventSubscriptions_Get": {
+ "$ref": "./examples/DomainEventSubscriptions_Get.json"
}
}
- }
- },
- "/providers/Microsoft.EventGrid/topicTypes": {
- "get": {
+ },
+ "put": {
"tags": [
- "TopicTypes"
+ "EventSubscriptions"
+ ],
+ "summary": "Create or update an event subscription to a domain.",
+ "description": "Asynchronously creates a new event subscription or updates an existing event subscription.",
+ "operationId": "DomainEventSubscriptions_CreateOrUpdate",
+ "consumes": [
+ "application/json"
],
- "summary": "List topic types.",
- "description": "List all registered topic types.",
- "operationId": "TopicTypes_List",
- "consumes": [],
"produces": [
"application/json"
],
"parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the domain topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionInfo",
+ "in": "body",
+ "description": "Event subscription properties containing the destination and filter information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
+ }
+ },
{
"$ref": "#/parameters/ApiVersionParameter"
}
@@ -2195,82 +2322,191 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/TopicTypesListResult"
+ "$ref": "#/definitions/EventSubscription"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
}
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
- "x-ms-pageable": {
- "nextLinkName": null
- },
"x-ms-examples": {
- "TopicTypes_List": {
- "$ref": "./examples/TopicTypes_List.json"
+ "DomainEventSubscriptions_CreateOrUpdate": {
+ "$ref": "./examples/DomainEventSubscriptions_CreateOrUpdate.json"
}
- }
- }
- },
- "/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}": {
- "get": {
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
"tags": [
- "TopicTypes"
+ "EventSubscriptions"
],
- "summary": "Get a topic type.",
- "description": "Get information about a topic type.",
- "operationId": "TopicTypes_Get",
+ "summary": "Delete an event subscription for a domain.",
+ "description": "Delete an existing event subscription for a domain.",
+ "operationId": "DomainEventSubscriptions_Delete",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
- "name": "topicTypeName",
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
"in": "path",
- "description": "Name of the topic type.",
+ "description": "The name of the resource group within the user's subscription.",
"required": true,
"type": "string"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
- }
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
],
"responses": {
"200": {
- "description": "OK",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "DomainEventSubscriptions_Delete": {
+ "$ref": "./examples/DomainEventSubscriptions_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Update an event subscription for a domain.",
+ "description": "Update an existing event subscription for a topic.",
+ "operationId": "DomainEventSubscriptions_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be updated.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionUpdateParameters",
+ "in": "body",
+ "description": "Updated event subscription information.",
+ "required": true,
"schema": {
- "$ref": "#/definitions/TopicTypeInfo"
+ "$ref": "#/definitions/EventSubscriptionUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
}
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"x-ms-examples": {
- "TopicTypes_Get": {
- "$ref": "./examples/TopicTypes_Get.json"
+ "DomainEventSubscriptions_Update": {
+ "$ref": "./examples/DomainEventSubscriptions_Update.json"
}
- }
+ },
+ "x-ms-long-running-operation": true
}
},
- "/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventTypes": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}": {
"get": {
"tags": [
- "TopicTypes"
+ "EventSubscriptions"
],
- "summary": "List event types.",
- "description": "List event types for a topic type.",
- "operationId": "TopicTypes_ListEventTypes",
+ "summary": "Get an event subscription of a system topic.",
+ "description": "Get an event subscription.",
+ "operationId": "SystemTopicEventSubscriptions_Get",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
- "name": "topicTypeName",
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
"in": "path",
- "description": "Name of the topic type.",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "systemTopicName",
+ "in": "path",
+ "description": "Name of the system topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
"required": true,
"type": "string"
},
@@ -2282,201 +2518,7999 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/EventTypesListResult"
+ "$ref": "#/definitions/EventSubscription"
}
},
"default": {
- "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
- "x-ms-pageable": {
- "nextLinkName": null
- },
"x-ms-examples": {
- "TopicTypes_ListEventTypes": {
- "$ref": "./examples/TopicTypes_ListEventTypes.json"
+ "SystemTopicEventSubscriptions_Get": {
+ "$ref": "./examples/SystemTopicEventSubscriptions_Get.json"
}
}
- }
- }
- },
- "definitions": {
- "DomainProperties": {
- "description": "Properties of the Domain.",
- "type": "object",
- "properties": {
- "provisioningState": {
- "description": "Provisioning state of the domain.",
- "enum": [
- "Creating",
- "Updating",
- "Deleting",
- "Succeeded",
- "Canceled",
- "Failed"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "DomainProvisioningState",
- "modelAsString": true
+ },
+ "put": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Create or update an event subscription for a system topic.",
+ "description": "Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.",
+ "operationId": "SystemTopicEventSubscriptions_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "systemTopicName",
+ "in": "path",
+ "description": "Name of the system topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionInfo",
+ "in": "body",
+ "description": "Event subscription properties containing the destination and filter information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
- "endpoint": {
- "description": "Endpoint for the domain.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "Resource": {
- "description": "Definition of a Resource.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Fully qualified identifier of the resource.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Name of the resource.",
- "type": "string",
- "readOnly": true
+ "x-ms-examples": {
+ "SystemTopicEventSubscriptions_CreateOrUpdate": {
+ "$ref": "./examples/SystemTopicEventSubscriptions_CreateOrUpdate.json"
+ }
},
- "type": {
- "description": "Type of the resource.",
- "type": "string",
- "readOnly": true
- }
+ "x-ms-long-running-operation": true
},
- "x-ms-azure-resource": true
- },
- "TrackedResource": {
- "description": "Definition of a Tracked Resource.",
- "required": [
- "location"
- ],
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/Resource"
- }
- ],
- "properties": {
- "location": {
- "description": "Location of the resource.",
- "type": "string",
- "x-ms-mutability": [
- "read",
- "create"
- ]
+ "delete": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Delete an event subscription of a system topic.",
+ "description": "Delete an existing event subscription of a system topic.",
+ "operationId": "SystemTopicEventSubscriptions_Delete",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "systemTopicName",
+ "in": "path",
+ "description": "Name of the system topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "SystemTopicEventSubscriptions_Delete": {
+ "$ref": "./examples/SystemTopicEventSubscriptions_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Update event subscription of a system topic.",
+ "description": "Update an existing event subscription of a system topic.",
+ "operationId": "SystemTopicEventSubscriptions_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "systemTopicName",
+ "in": "path",
+ "description": "Name of the system topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionUpdateParameters",
+ "in": "body",
+ "description": "Updated event subscription information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/EventSubscriptionUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "SystemTopicEventSubscriptions_Update": {
+ "$ref": "./examples/SystemTopicEventSubscriptions_Update.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl": {
+ "post": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get full URL of an event subscription of a system topic",
+ "description": "Get the full endpoint URL for an event subscription of a system topic.",
+ "operationId": "SystemTopicEventSubscriptions_GetFullUrl",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "systemTopicName",
+ "in": "path",
+ "description": "Name of the system topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "SystemTopicEventSubscriptions_GetFullUrl": {
+ "$ref": "./examples/SystemTopicEventSubscriptions_GetFullUrl.json"
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}/getFullUrl": {
+ "post": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get full URL of an event subscription.",
+ "description": "Get the full endpoint URL for an event subscription.",
+ "operationId": "EventSubscriptions_GetFullUrl",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "scope",
+ "in": "path",
+ "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.",
+ "required": true,
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "EventSubscriptions_GetFullUrlForSubscription": {
+ "$ref": "./examples/EventSubscriptions_GetFullUrlForSubscription.json"
+ },
+ "EventSubscriptions_GetFullUrlForResourceGroup": {
+ "$ref": "./examples/EventSubscriptions_GetFullUrlForResourceGroup.json"
+ },
+ "EventSubscriptions_GetFullUrlForResource": {
+ "$ref": "./examples/EventSubscriptions_GetFullUrlForResource.json"
+ },
+ "EventSubscriptions_GetFullUrlForCustomTopic": {
+ "$ref": "./examples/EventSubscriptions_GetFullUrlForCustomTopic.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List event subscriptions of a system topic.",
+ "description": "List event subscriptions that belong to a specific system topic.",
+ "operationId": "SystemTopicEventSubscriptions_ListBySystemTopic",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "systemTopicName",
+ "in": "path",
+ "description": "Name of the system topic.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "SystemTopicEventSubscriptions_ListBySystemTopic": {
+ "$ref": "./examples/SystemTopicEventSubscriptions_ListBySystemTopic.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get an event subscription of a partner topic.",
+ "description": "Get properties of an event subscription of a partner topic.",
+ "operationId": "PartnerTopicEventSubscriptions_Get",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopicEventSubscriptions_Get": {
+ "$ref": "./examples/PartnerTopicEventSubscriptions_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Create or update an event subscription of a partner topic.",
+ "description": "Asynchronously creates or updates an event subscription of a partner topic with the specified parameters. Existing event subscriptions will be updated with this API.",
+ "operationId": "PartnerTopicEventSubscriptions_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionInfo",
+ "in": "body",
+ "description": "Event subscription properties containing the destination and filter information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopicEventSubscriptions_CreateOrUpdate": {
+ "$ref": "./examples/PartnerTopicEventSubscriptions_CreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Delete an event subscription of a partner topic.",
+ "description": "Delete an existing event subscription of a partner topic.",
+ "operationId": "PartnerTopicEventSubscriptions_Delete",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopicEventSubscriptions_Delete": {
+ "$ref": "./examples/PartnerTopicEventSubscriptions_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Update event subscription of a partner topic.",
+ "description": "Update an existing event subscription of a partner topic.",
+ "operationId": "PartnerTopicEventSubscriptions_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionUpdateParameters",
+ "in": "body",
+ "description": "Updated event subscription information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/EventSubscriptionUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/EventSubscription"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopicEventSubscriptions_Update": {
+ "$ref": "./examples/PartnerTopicEventSubscriptions_Update.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl": {
+ "post": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get full URL of an event subscription of a partner topic.",
+ "description": "Get the full endpoint URL for an event subscription of a partner topic.",
+ "operationId": "PartnerTopicEventSubscriptions_GetFullUrl",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopicEventSubscriptions_GetFullUrl": {
+ "$ref": "./examples/PartnerTopicEventSubscriptions_GetFullUrl.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List event subscriptions of a partner topic.",
+ "description": "List event subscriptions that belong to a specific partner topic.",
+ "operationId": "PartnerTopicEventSubscriptions_ListByPartnerTopic",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopicEventSubscriptions_ListByPartnerTopic": {
+ "$ref": "./examples/PartnerTopicEventSubscriptions_ListByPartnerTopic.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl": {
+ "post": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get full URL of a nested event subscription for domain topic.",
+ "description": "Get the full endpoint URL for a nested event subscription for domain topic.",
+ "operationId": "DomainTopicEventSubscriptions_GetFullUrl",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the top level domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the domain topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "DomainTopicEventSubscriptions_GetFullUrl": {
+ "$ref": "./examples/DomainTopicEventSubscriptions_GetFullUrl.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl": {
+ "post": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get full URL of an event subscription for topic.",
+ "description": "Get the full endpoint URL for an event subscription for topic.",
+ "operationId": "TopicEventSubscriptions_GetFullUrl",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the domain topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "TopicEventSubscriptions_GetFullUrl": {
+ "$ref": "./examples/TopicEventSubscriptions_GetFullUrl.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl": {
+ "post": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get full URL of an event subscription for domain.",
+ "description": "Get the full endpoint URL for an event subscription for domain.",
+ "operationId": "DomainEventSubscriptions_GetFullUrl",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the domain topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "DomainEventSubscriptions_GetFullUrl": {
+ "$ref": "./examples/DomainEventSubscriptions_GetFullUrl.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get an aggregated list of all global event subscriptions under an Azure subscription.",
+ "description": "List all aggregated global event subscriptions under a specific Azure subscription.",
+ "operationId": "EventSubscriptions_ListGlobalBySubscription",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "EventSubscriptions_ListGlobalBySubscription": {
+ "$ref": "./examples/EventSubscriptions_ListGlobalBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List all global event subscriptions for a topic type.",
+ "description": "List all global event subscriptions under an Azure subscription for a topic type.",
+ "operationId": "EventSubscriptions_ListGlobalBySubscriptionForTopicType",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "topicTypeName",
+ "in": "path",
+ "description": "Name of the topic type.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "EventSubscriptions_ListGlobalBySubscriptionForTopicType": {
+ "$ref": "./examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List all global event subscriptions under an Azure subscription and resource group.",
+ "description": "List all global event subscriptions under a specific Azure subscription and resource group.",
+ "operationId": "EventSubscriptions_ListGlobalByResourceGroup",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "EventSubscriptions_ListGlobalByResourceGroup": {
+ "$ref": "./examples/EventSubscriptions_ListGlobalByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List all global event subscriptions under a resource group for a topic type.",
+ "description": "List all global event subscriptions under a resource group for a specific topic type.",
+ "operationId": "EventSubscriptions_ListGlobalByResourceGroupForTopicType",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicTypeName",
+ "in": "path",
+ "description": "Name of the topic type.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "EventSubscriptions_ListGlobalByResourceGroupForTopicType": {
+ "$ref": "./examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List all regional event subscriptions under an Azure subscription.",
+ "description": "List all event subscriptions from the given location under a specific Azure subscription.",
+ "operationId": "EventSubscriptions_ListRegionalBySubscription",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "description": "Name of the 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."
+ }
+ },
+ "x-ms-examples": {
+ "EventSubscriptions_ListRegionalBySubscription": {
+ "$ref": "./examples/EventSubscriptions_ListRegionalBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List all regional event subscriptions under an Azure subscription and resource group.",
+ "description": "List all event subscriptions from the given location under a specific Azure subscription and resource group.",
+ "operationId": "EventSubscriptions_ListRegionalByResourceGroup",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "description": "Name of the 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."
+ }
+ },
+ "x-ms-examples": {
+ "EventSubscriptions_ListRegionalByResourceGroup": {
+ "$ref": "./examples/EventSubscriptions_ListRegionalByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List all regional event subscriptions under an Azure subscription for a topic type.",
+ "description": "List all event subscriptions from the given location under a specific Azure subscription and topic type.",
+ "operationId": "EventSubscriptions_ListRegionalBySubscriptionForTopicType",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "description": "Name of the location.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicTypeName",
+ "in": "path",
+ "description": "Name of the topic type.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "EventSubscriptions_ListRegionalBySubscriptionForTopicType": {
+ "$ref": "./examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List all regional event subscriptions under an Azure subscription and resource group for a topic type.",
+ "description": "List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.",
+ "operationId": "EventSubscriptions_ListRegionalByResourceGroupForTopicType",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "description": "Name of the location.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicTypeName",
+ "in": "path",
+ "description": "Name of the topic type.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "EventSubscriptions_ListRegionalByResourceGroupForTopicType": {
+ "$ref": "./examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List all event subscriptions.",
+ "description": "List all event subscriptions that have been created for a specific resource.",
+ "operationId": "EventSubscriptions_ListByResource",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "providerNamespace",
+ "in": "path",
+ "description": "Namespace of the provider of the topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "resourceTypeName",
+ "in": "path",
+ "description": "Name of the resource type.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "description": "Name of the resource.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "EventSubscriptions_ListByResource": {
+ "$ref": "./examples/EventSubscriptions_ListByResource.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List all event subscriptions for a specific topic.",
+ "description": "List all event subscriptions that have been created for a specific topic.",
+ "operationId": "TopicEventSubscriptions_List",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the topic.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "TopicEventSubscriptions_List": {
+ "$ref": "./examples/TopicEventSubscriptions_List.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List all event subscriptions for a specific domain.",
+ "description": "List all event subscriptions that have been created for a specific topic.",
+ "operationId": "DomainEventSubscriptions_List",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the domain.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "DomainEventSubscriptions_List": {
+ "$ref": "./examples/DomainEventSubscriptions_List.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/providers/Microsoft.EventGrid/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List all event subscriptions for a specific domain topic.",
+ "description": "List all event subscriptions that have been created for a specific domain topic.",
+ "operationId": "EventSubscriptions_ListByDomainTopic",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the top level domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the domain topic.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "EventSubscriptions_ListByDomainTopic": {
+ "$ref": "./examples/EventSubscriptions_ListByDomainTopic.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions": {
+ "get": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "List all nested event subscriptions for a specific domain topic.",
+ "description": "List all event subscriptions that have been created for a specific domain topic.",
+ "operationId": "DomainTopicEventSubscriptions_List",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the top level domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the domain topic.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "DomainTopicEventSubscriptions_List": {
+ "$ref": "./examples/DomainTopicEventSubscriptions_List.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes": {
+ "post": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get delivery attributes for an event subscription.",
+ "description": "Get all delivery attributes for an event subscription.",
+ "operationId": "EventSubscriptions_GetDeliveryAttributes",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "scope",
+ "in": "path",
+ "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.",
+ "required": true,
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeliveryAttributeListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "EventSubscriptions_GetDeliveryAttributes": {
+ "$ref": "./examples/EventSubscriptions_GetDeliveryAttributes.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes": {
+ "post": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get delivery attributes for an event subscription.",
+ "description": "Get all delivery attributes for an event subscription.",
+ "operationId": "SystemTopicEventSubscriptions_GetDeliveryAttributes",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "systemTopicName",
+ "in": "path",
+ "description": "Name of the system topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeliveryAttributeListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "SystemTopicEventSubscriptions_GetDeliveryAttributes": {
+ "$ref": "./examples/SystemTopicEventSubscriptions_GetDeliveryAttributes.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes": {
+ "post": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get delivery attributes for an event subscription of a partner topic.",
+ "description": "Get all delivery attributes for an event subscription of a partner topic.",
+ "operationId": "PartnerTopicEventSubscriptions_GetDeliveryAttributes",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeliveryAttributeListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopicEventSubscriptions_GetDeliveryAttributes": {
+ "$ref": "./examples/PartnerTopicEventSubscriptions_GetDeliveryAttributes.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes": {
+ "post": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get delivery attributes for an event subscription for domain topic.",
+ "description": "Get all delivery attributes for an event subscription for domain topic.",
+ "operationId": "DomainTopicEventSubscriptions_GetDeliveryAttributes",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the top level domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the domain topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeliveryAttributeListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "DomainTopicEventSubscriptions_GetDeliveryAttributes": {
+ "$ref": "./examples/DomainTopicEventSubscriptions_GetDeliveryAttributes.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes": {
+ "post": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get delivery attributes for an event subscription for topic.",
+ "description": "Get all delivery attributes for an event subscription for topic.",
+ "operationId": "TopicEventSubscriptions_GetDeliveryAttributes",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the domain topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeliveryAttributeListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "TopicEventSubscriptions_GetDeliveryAttributes": {
+ "$ref": "./examples/TopicEventSubscriptions_GetDeliveryAttributes.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes": {
+ "post": {
+ "tags": [
+ "EventSubscriptions"
+ ],
+ "summary": "Get delivery attributes for an event subscription for domain.",
+ "description": "Get all delivery attributes for an event subscription for domain.",
+ "operationId": "DomainEventSubscriptions_GetDeliveryAttributes",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the domain topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventSubscriptionName",
+ "in": "path",
+ "description": "Name of the event subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeliveryAttributeListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "DomainEventSubscriptions_GetDeliveryAttributes": {
+ "$ref": "./examples/DomainEventSubscriptions_GetDeliveryAttributes.json"
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.EventGrid/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "summary": "List available operations.",
+ "description": "List the available operations supported by the Microsoft.EventGrid resource provider.",
+ "operationId": "Operations_List",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "Operations_List": {
+ "$ref": "./examples/Operations_List.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default": {
+ "get": {
+ "tags": [
+ "PartnerConfigurations"
+ ],
+ "summary": "Get a partner configuration.",
+ "description": "Get properties of a partner configuration.",
+ "operationId": "PartnerConfigurations_Get",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerConfiguration"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerConfigurations_Get": {
+ "$ref": "./examples/PartnerConfigurations_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PartnerConfigurations"
+ ],
+ "summary": "Create or update a partner configuration.",
+ "description": "Synchronously creates or updates a partner configuration with the specified parameters.",
+ "operationId": "PartnerConfigurations_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerConfigurationInfo",
+ "in": "body",
+ "description": "Partner configuration information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PartnerConfiguration"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerConfiguration"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/PartnerConfiguration"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerConfigurations_CreateOrUpdate": {
+ "$ref": "./examples/PartnerConfigurations_CreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "PartnerConfigurations"
+ ],
+ "summary": "Delete a partner configuration.",
+ "description": "Delete existing partner configuration.",
+ "operationId": "PartnerConfigurations_Delete",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerConfigurations_Delete": {
+ "$ref": "./examples/PartnerConfigurations_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "PartnerConfigurations"
+ ],
+ "summary": "Update a partner configuration.",
+ "description": "Synchronously updates a partner configuration with the specified parameters.",
+ "operationId": "PartnerConfigurations_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerConfigurationUpdateParameters",
+ "in": "body",
+ "description": "Partner configuration update information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PartnerConfigurationUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerConfiguration"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/PartnerConfiguration"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerConfigurations_Update": {
+ "$ref": "./examples/PartnerConfigurations_Update.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations": {
+ "get": {
+ "tags": [
+ "PartnerConfigurations"
+ ],
+ "summary": "List partner configurations under a resource group.",
+ "description": "List all the partner configurations under a resource group.",
+ "operationId": "PartnerConfigurations_ListByResourceGroup",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerConfigurationsListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerConfigurations_ListByResourceGroup": {
+ "$ref": "./examples/PartnerConfigurations_ListByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerConfigurations": {
+ "get": {
+ "tags": [
+ "PartnerConfigurations"
+ ],
+ "summary": "List partner configurations under an Azure subscription.",
+ "description": "List all the partner configurations under an Azure subscription.",
+ "operationId": "PartnerConfigurations_ListBySubscription",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerConfigurationsListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerConfigurations_ListBySubscription": {
+ "$ref": "./examples/PartnerConfigurations_ListBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default/authorizePartner": {
+ "post": {
+ "tags": [
+ "PartnerConfigurations"
+ ],
+ "summary": "Authorize a partner.",
+ "description": "Authorize a single partner either by partner registration immutable Id or by partner name.",
+ "operationId": "PartnerConfigurations_AuthorizePartner",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerInfo",
+ "in": "body",
+ "description": "The information of the partner to be authorized.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Partner"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerConfiguration"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerConfigurations_AuthorizePartner": {
+ "$ref": "./examples/PartnerConfigurations_AuthorizePartner.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default/unauthorizePartner": {
+ "post": {
+ "tags": [
+ "PartnerConfigurations"
+ ],
+ "summary": "Unauthorize a partner.",
+ "description": "Unauthorize a single partner either by partner registration immutable Id or by partner name.",
+ "operationId": "PartnerConfigurations_UnauthorizePartner",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerInfo",
+ "in": "body",
+ "description": "The information of the partner to be unauthorized.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Partner"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerConfiguration"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerConfigurations_UnauthorizePartner": {
+ "$ref": "./examples/PartnerConfigurations_UnauthorizePartner.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}": {
+ "get": {
+ "tags": [
+ "PartnerDestinations"
+ ],
+ "summary": "Get a partner destination.",
+ "description": "Get properties of a partner destination.",
+ "operationId": "PartnerDestinations_Get",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerDestinationName",
+ "in": "path",
+ "description": "Name of the partner destination.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerDestination"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerDestinations_Get": {
+ "$ref": "./examples/PartnerDestinations_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PartnerDestinations"
+ ],
+ "summary": "Create a partner destination.",
+ "description": "Asynchronously creates a new partner destination with the specified parameters.",
+ "operationId": "PartnerDestinations_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerDestinationName",
+ "in": "path",
+ "description": "Name of the partner destination.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerDestination",
+ "in": "body",
+ "description": "Partner destination create information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PartnerDestination"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerDestination"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/PartnerDestination"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerDestinations_CreateOrUpdate": {
+ "$ref": "./examples/PartnerDestinations_CreateOrUpdate.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "PartnerDestinations"
+ ],
+ "summary": "Delete a partner destination.",
+ "description": "Delete existing partner destination.",
+ "operationId": "PartnerDestinations_Delete",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerDestinationName",
+ "in": "path",
+ "description": "Name of the partner destination.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerDestinations_Delete": {
+ "$ref": "./examples/PartnerDestinations_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "PartnerDestinations"
+ ],
+ "summary": "Update a partner destination.",
+ "description": "Asynchronously updates a partner destination with the specified parameters.",
+ "operationId": "PartnerDestinations_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerDestinationName",
+ "in": "path",
+ "description": "Name of the partner destination.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerDestinationUpdateParameters",
+ "in": "body",
+ "description": "Partner destination update information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PartnerDestinationUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "201": {
+ "description": "Partner Destination update request accepted.",
+ "schema": {
+ "$ref": "#/definitions/PartnerDestination"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerDestinations_Update": {
+ "$ref": "./examples/PartnerDestinations_Update.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerDestinations": {
+ "get": {
+ "tags": [
+ "PartnerDestinations"
+ ],
+ "summary": "List partner destinations under an Azure subscription.",
+ "description": "List all the partner destinations under an Azure subscription.",
+ "operationId": "PartnerDestinations_ListBySubscription",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerDestinationsListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerDestinations_ListBySubscription": {
+ "$ref": "./examples/PartnerDestinations_ListBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations": {
+ "get": {
+ "tags": [
+ "PartnerDestinations"
+ ],
+ "summary": "List partner destinations under a resource group.",
+ "description": "List all the partner destinations under a resource group.",
+ "operationId": "PartnerDestinations_ListByResourceGroup",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerDestinationsListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerDestinations_ListByResourceGroup": {
+ "$ref": "./examples/PartnerDestinations_ListByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}/activate": {
+ "post": {
+ "tags": [
+ "PartnerDestinations"
+ ],
+ "summary": "Activate a partner destination.",
+ "description": "Activate a newly created partner destination.",
+ "operationId": "PartnerDestinations_Activate",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerDestinationName",
+ "in": "path",
+ "description": "Name of the partner destination.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerDestination"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerDestinations_Activate": {
+ "$ref": "./examples/PartnerDestinations_Activate.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}": {
+ "get": {
+ "tags": [
+ "PartnerNamespaces"
+ ],
+ "summary": "Get a partner namespace.",
+ "description": "Get properties of a partner namespace.",
+ "operationId": "PartnerNamespaces_Get",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerNamespaceName",
+ "in": "path",
+ "description": "Name of the partner namespace.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerNamespace"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerNamespaces_Get": {
+ "$ref": "./examples/PartnerNamespaces_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PartnerNamespaces"
+ ],
+ "summary": "Create a partner namespace.",
+ "description": "Asynchronously creates a new partner namespace with the specified parameters.",
+ "operationId": "PartnerNamespaces_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerNamespaceName",
+ "in": "path",
+ "description": "Name of the partner namespace.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerNamespaceInfo",
+ "in": "body",
+ "description": "PartnerNamespace information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PartnerNamespace"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/PartnerNamespace"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerNamespaces_CreateOrUpdate": {
+ "$ref": "./examples/PartnerNamespaces_CreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "PartnerNamespaces"
+ ],
+ "summary": "Delete a partner namespace.",
+ "description": "Delete existing partner namespace.",
+ "operationId": "PartnerNamespaces_Delete",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerNamespaceName",
+ "in": "path",
+ "description": "Name of the partner namespace.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerNamespaces_Delete": {
+ "$ref": "./examples/PartnerNamespaces_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "PartnerNamespaces"
+ ],
+ "summary": "Update a partner namespace.",
+ "description": "Asynchronously updates a partner namespace with the specified parameters.",
+ "operationId": "PartnerNamespaces_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerNamespaceName",
+ "in": "path",
+ "description": "Name of the partner namespace.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerNamespaceUpdateParameters",
+ "in": "body",
+ "description": "Partner namespace update information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PartnerNamespaceUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "201": {
+ "description": "Partner namespace update request accepted.",
+ "schema": {
+ "$ref": "#/definitions/PartnerNamespace"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerNamespaces_Update": {
+ "$ref": "./examples/PartnerNamespaces_Update.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerNamespaces": {
+ "get": {
+ "tags": [
+ "PartnerNamespaces"
+ ],
+ "summary": "List partner namespaces under an Azure subscription.",
+ "description": "List all the partner namespaces under an Azure subscription.",
+ "operationId": "PartnerNamespaces_ListBySubscription",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerNamespacesListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerNamespaces_ListBySubscription": {
+ "$ref": "./examples/PartnerNamespaces_ListBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces": {
+ "get": {
+ "tags": [
+ "PartnerNamespaces"
+ ],
+ "summary": "List partner namespaces under a resource group.",
+ "description": "List all the partner namespaces under a resource group.",
+ "operationId": "PartnerNamespaces_ListByResourceGroup",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerNamespacesListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerNamespaces_ListByResourceGroup": {
+ "$ref": "./examples/PartnerNamespaces_ListByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/listKeys": {
+ "post": {
+ "tags": [
+ "PartnerNamespaces"
+ ],
+ "summary": "List keys for a partner namespace.",
+ "description": "List the two keys used to publish to a partner namespace.",
+ "operationId": "PartnerNamespaces_ListSharedAccessKeys",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerNamespaceName",
+ "in": "path",
+ "description": "Name of the partner namespace.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerNamespaceSharedAccessKeys"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerNamespaces_ListSharedAccessKeys": {
+ "$ref": "./examples/PartnerNamespaces_ListSharedAccessKeys.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/regenerateKey": {
+ "post": {
+ "tags": [
+ "PartnerNamespaces"
+ ],
+ "summary": "Regenerate key for a partner namespace.",
+ "description": "Regenerate a shared access key for a partner namespace.",
+ "operationId": "PartnerNamespaces_RegenerateKey",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerNamespaceName",
+ "in": "path",
+ "description": "Name of the partner namespace.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "regenerateKeyRequest",
+ "in": "body",
+ "description": "Request body to regenerate key.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PartnerNamespaceRegenerateKeyRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerNamespaceSharedAccessKeys"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerNamespaces_RegenerateKey": {
+ "$ref": "./examples/PartnerNamespaces_RegenerateKey.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}": {
+ "get": {
+ "tags": [
+ "PartnerRegistrations"
+ ],
+ "summary": "Get a partner registration.",
+ "description": "Gets a partner registration with the specified parameters.",
+ "operationId": "PartnerRegistrations_Get",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerRegistrationName",
+ "in": "path",
+ "description": "Name of the partner registration.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerRegistration"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerRegistrations_Get": {
+ "$ref": "./examples/PartnerRegistrations_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PartnerRegistrations"
+ ],
+ "summary": "Create a partner registration.",
+ "description": "Creates a new partner registration with the specified parameters.",
+ "operationId": "PartnerRegistrations_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerRegistrationName",
+ "in": "path",
+ "description": "Name of the partner registration.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerRegistrationInfo",
+ "in": "body",
+ "description": "PartnerRegistration information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PartnerRegistration"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerRegistration"
+ }
+ },
+ "202": {
+ "description": "Accepted",
+ "schema": {
+ "$ref": "#/definitions/PartnerRegistration"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerRegistrations_CreateOrUpdate": {
+ "$ref": "./examples/PartnerRegistrations_CreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "PartnerRegistrations"
+ ],
+ "summary": "Delete a partner registration.",
+ "description": "Deletes a partner registration with the specified parameters.",
+ "operationId": "PartnerRegistrations_Delete",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerRegistrationName",
+ "in": "path",
+ "description": "Name of the partner registration.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerRegistrations_Delete": {
+ "$ref": "./examples/PartnerRegistrations_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "PartnerRegistrations"
+ ],
+ "summary": "Update a partner registration.",
+ "description": "Updates a partner registration with the specified parameters.",
+ "operationId": "PartnerRegistrations_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerRegistrationName",
+ "in": "path",
+ "description": "Name of the partner registration.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerRegistrationUpdateParameters",
+ "in": "body",
+ "description": "Partner registration update information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PartnerRegistrationUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "201": {
+ "description": "Partner registration update request accepted.",
+ "schema": {
+ "$ref": "#/definitions/PartnerRegistration"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerRegistrations_Update": {
+ "$ref": "./examples/PartnerRegistrations_Update.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerRegistrations": {
+ "get": {
+ "tags": [
+ "PartnerRegistrations"
+ ],
+ "summary": "List partner registrations under an Azure subscription.",
+ "description": "List all the partner registrations under an Azure subscription.",
+ "operationId": "PartnerRegistrations_ListBySubscription",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerRegistrationsListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerRegistrations_ListBySubscription": {
+ "$ref": "./examples/PartnerRegistrations_ListBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations": {
+ "get": {
+ "tags": [
+ "PartnerRegistrations"
+ ],
+ "summary": "List partner registrations under a resource group.",
+ "description": "List all the partner registrations under a resource group.",
+ "operationId": "PartnerRegistrations_ListByResourceGroup",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerRegistrationsListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerRegistrations_ListByResourceGroup": {
+ "$ref": "./examples/PartnerRegistrations_ListByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}": {
+ "get": {
+ "tags": [
+ "PartnerTopics"
+ ],
+ "summary": "Get a partner topic.",
+ "description": "Get properties of a partner topic.",
+ "operationId": "PartnerTopics_Get",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerTopic"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopics_Get": {
+ "$ref": "./examples/PartnerTopics_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PartnerTopics"
+ ],
+ "summary": "Create a partner topic.",
+ "description": "Asynchronously creates a new partner topic with the specified parameters.",
+ "operationId": "PartnerTopics_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicInfo",
+ "in": "body",
+ "description": "Partner Topic information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PartnerTopic"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerTopic"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/PartnerTopic"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopics_CreateOrUpdate": {
+ "$ref": "./examples/PartnerTopics_CreateOrUpdate.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "PartnerTopics"
+ ],
+ "summary": "Delete a partner topic.",
+ "description": "Delete existing partner topic.",
+ "operationId": "PartnerTopics_Delete",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopics_Delete": {
+ "$ref": "./examples/PartnerTopics_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "PartnerTopics"
+ ],
+ "summary": "Update a partner topic.",
+ "description": "Asynchronously updates a partner topic with the specified parameters.",
+ "operationId": "PartnerTopics_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicUpdateParameters",
+ "in": "body",
+ "description": "PartnerTopic update information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PartnerTopicUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "201": {
+ "description": "Partner Topic update request accepted.",
+ "schema": {
+ "$ref": "#/definitions/PartnerTopic"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopics_Update": {
+ "$ref": "./examples/PartnerTopics_Update.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerTopics": {
+ "get": {
+ "tags": [
+ "PartnerTopics"
+ ],
+ "summary": "List partner topics under an Azure subscription.",
+ "description": "List all the partner topics under an Azure subscription.",
+ "operationId": "PartnerTopics_ListBySubscription",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerTopicsListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopics_ListBySubscription": {
+ "$ref": "./examples/PartnerTopics_ListBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics": {
+ "get": {
+ "tags": [
+ "PartnerTopics"
+ ],
+ "summary": "List partner topics under a resource group.",
+ "description": "List all the partner topics under a resource group.",
+ "operationId": "PartnerTopics_ListByResourceGroup",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerTopicsListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopics_ListByResourceGroup": {
+ "$ref": "./examples/PartnerTopics_ListByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/activate": {
+ "post": {
+ "tags": [
+ "PartnerTopics"
+ ],
+ "summary": "Activate a partner topic.",
+ "description": "Activate a newly created partner topic.",
+ "operationId": "PartnerTopics_Activate",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerTopic"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopics_Activate": {
+ "$ref": "./examples/PartnerTopics_Activate.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/deactivate": {
+ "post": {
+ "tags": [
+ "PartnerTopics"
+ ],
+ "summary": "Deactivate a partner topic.",
+ "description": "Deactivate specific partner topic.",
+ "operationId": "PartnerTopics_Deactivate",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "partnerTopicName",
+ "in": "path",
+ "description": "Name of the partner topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PartnerTopic"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PartnerTopics_Deactivate": {
+ "$ref": "./examples/PartnerTopics_Deactivate.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName}": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "summary": "Get a specific private endpoint connection.",
+ "description": "Get a specific private endpoint connection under a topic, domain, or partner namespace.",
+ "operationId": "PrivateEndpointConnections_Get",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parentType",
+ "in": "path",
+ "description": "The type of the parent resource. This can be either \\'topics\\', \\'domains\\', or \\'partnerNamespaces\\'.",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "topics",
+ "domains",
+ "partnerNamespaces"
+ ],
+ "x-ms-enum": {
+ "name": "ParentType",
+ "modelAsString": true
+ }
+ },
+ {
+ "name": "parentName",
+ "in": "path",
+ "description": "The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "description": "The name of the private endpoint connection connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnections_Get": {
+ "$ref": "./examples/PrivateEndpointConnections_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "summary": "Update a specific private endpoint connection.",
+ "description": "Update a specific private endpoint connection under a topic, domain or partner namespace.",
+ "operationId": "PrivateEndpointConnections_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parentType",
+ "in": "path",
+ "description": "The type of the parent resource. This can be either \\'topics\\', \\'domains\\', or \\'partnerNamespaces\\'.",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "topics",
+ "domains",
+ "partnerNamespaces"
+ ],
+ "x-ms-enum": {
+ "name": "ParentType",
+ "modelAsString": true
+ }
+ },
+ {
+ "name": "parentName",
+ "in": "path",
+ "description": "The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "description": "The name of the private endpoint connection connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "privateEndpointConnection",
+ "in": "body",
+ "description": "The private endpoint connection object to update.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnections_Update": {
+ "$ref": "./examples/PrivateEndpointConnections_Update.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "summary": "Delete a specific private endpoint connection.",
+ "description": "Delete a specific private endpoint connection under a topic, domain, or partner namespace.",
+ "operationId": "PrivateEndpointConnections_Delete",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parentType",
+ "in": "path",
+ "description": "The type of the parent resource. This can be either \\'topics\\', \\'domains\\', or \\'partnerNamespaces\\'.",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "topics",
+ "domains",
+ "partnerNamespaces"
+ ],
+ "x-ms-enum": {
+ "name": "ParentType",
+ "modelAsString": true
+ }
+ },
+ {
+ "name": "parentName",
+ "in": "path",
+ "description": "The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "description": "The name of the private endpoint connection connection.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnections_Delete": {
+ "$ref": "./examples/PrivateEndpointConnections_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "summary": "Lists all private endpoint connections under a resource.",
+ "description": "Get all private endpoint connections under a topic, domain, or partner namespace.",
+ "operationId": "PrivateEndpointConnections_ListByResource",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parentType",
+ "in": "path",
+ "description": "The type of the parent resource. This can be either \\'topics\\', \\'domains\\', or \\'partnerNamespaces\\'.",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "topics",
+ "domains",
+ "partnerNamespaces"
+ ],
+ "x-ms-enum": {
+ "name": "ParentType",
+ "modelAsString": true
+ }
+ },
+ {
+ "name": "parentName",
+ "in": "path",
+ "description": "The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnectionListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnections_ListByResource": {
+ "$ref": "./examples/PrivateEndpointConnections_ListByResource.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources/{privateLinkResourceName}": {
+ "get": {
+ "tags": [
+ "PrivateLinkResources"
+ ],
+ "summary": "Get a private link resource.",
+ "description": "Get properties of a private link resource.",
+ "operationId": "PrivateLinkResources_Get",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parentType",
+ "in": "path",
+ "description": "The type of the parent resource. This can be either \\'topics\\', \\'domains\\', or \\'partnerNamespaces\\'.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parentName",
+ "in": "path",
+ "description": "The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "privateLinkResourceName",
+ "in": "path",
+ "description": "The name of private link resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PrivateLinkResources_Get": {
+ "$ref": "./examples/PrivateLinkResources_Get.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "PrivateLinkResources"
+ ],
+ "summary": "List private link resources under specific topic, domain, or partner namespace.",
+ "description": "List all the private link resources under a topic, domain, or partner namespace.",
+ "operationId": "PrivateLinkResources_ListByResource",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parentType",
+ "in": "path",
+ "description": "The type of the parent resource. This can be either \\'topics\\', \\'domains\\', or \\'partnerNamespaces\\'.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parentName",
+ "in": "path",
+ "description": "The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResourcesListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "PrivateLinkResources_ListByResource": {
+ "$ref": "./examples/PrivateLinkResources_ListByResource.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}": {
+ "get": {
+ "tags": [
+ "SystemTopics"
+ ],
+ "summary": "Get a system topic.",
+ "description": "Get properties of a system topic.",
+ "operationId": "SystemTopics_Get",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "systemTopicName",
+ "in": "path",
+ "description": "Name of the system topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SystemTopic"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "SystemTopics_Get": {
+ "$ref": "./examples/SystemTopics_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "SystemTopics"
+ ],
+ "summary": "Create a system topic.",
+ "description": "Asynchronously creates a new system topic with the specified parameters.",
+ "operationId": "SystemTopics_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "systemTopicName",
+ "in": "path",
+ "description": "Name of the system topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "systemTopicInfo",
+ "in": "body",
+ "description": "System Topic information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SystemTopic"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SystemTopic"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/SystemTopic"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "SystemTopics_CreateOrUpdate": {
+ "$ref": "./examples/SystemTopics_CreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "SystemTopics"
+ ],
+ "summary": "Delete a system topic.",
+ "description": "Delete existing system topic.",
+ "operationId": "SystemTopics_Delete",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "systemTopicName",
+ "in": "path",
+ "description": "Name of the system topic.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "SystemTopics_Delete": {
+ "$ref": "./examples/SystemTopics_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "SystemTopics"
+ ],
+ "summary": "Update a system topic.",
+ "description": "Asynchronously updates a system topic with the specified parameters.",
+ "operationId": "SystemTopics_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "systemTopicName",
+ "in": "path",
+ "description": "Name of the system topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "systemTopicUpdateParameters",
+ "in": "body",
+ "description": "SystemTopic update information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SystemTopicUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "System Topic update request accepted.",
+ "schema": {
+ "$ref": "#/definitions/SystemTopic"
+ }
+ },
+ "201": {
+ "description": "System Topic update request accepted.",
+ "schema": {
+ "$ref": "#/definitions/SystemTopic"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "SystemTopics_Update": {
+ "$ref": "./examples/SystemTopics_Update.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/systemTopics": {
+ "get": {
+ "tags": [
+ "SystemTopics"
+ ],
+ "summary": "List system topics under an Azure subscription.",
+ "description": "List all the system topics under an Azure subscription.",
+ "operationId": "SystemTopics_ListBySubscription",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SystemTopicsListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "SystemTopics_ListBySubscription": {
+ "$ref": "./examples/SystemTopics_ListBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics": {
+ "get": {
+ "tags": [
+ "SystemTopics"
+ ],
+ "summary": "List system topics under a resource group.",
+ "description": "List all the system topics under a resource group.",
+ "operationId": "SystemTopics_ListByResourceGroup",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SystemTopicsListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "SystemTopics_ListByResourceGroup": {
+ "$ref": "./examples/SystemTopics_ListByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}": {
+ "get": {
+ "tags": [
+ "Topics"
+ ],
+ "summary": "Get a topic.",
+ "description": "Get properties of a topic.",
+ "operationId": "Topics_Get",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the topic.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "Topics_Get": {
+ "$ref": "./examples/Topics_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Topics"
+ ],
+ "summary": "Create a topic.",
+ "description": "Asynchronously creates a new topic with the specified parameters.",
+ "operationId": "Topics_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicInfo",
+ "in": "body",
+ "description": "Topic information.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "Topics_CreateOrUpdate": {
+ "$ref": "./examples/Topics_CreateOrUpdate.json"
+ },
+ "Topics_CreateOrUpdateForAzureArc": {
+ "$ref": "./examples/Topics_CreateOrUpdateForAzureArc.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "Topics"
+ ],
+ "summary": "Delete a topic.",
+ "description": "Delete existing topic.",
+ "operationId": "Topics_Delete",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the topic.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "Topics_Delete": {
+ "$ref": "./examples/Topics_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Topics"
+ ],
+ "summary": "Update a topic.",
+ "description": "Asynchronously updates a topic with the specified parameters.",
+ "operationId": "Topics_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicUpdateParameters",
+ "in": "body",
+ "description": "Topic update information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TopicUpdateParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "Topics_Update": {
+ "$ref": "./examples/Topics_Update.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics": {
+ "get": {
+ "tags": [
+ "Topics"
+ ],
+ "summary": "List topics under an Azure subscription.",
+ "description": "List all the topics under an Azure subscription.",
+ "operationId": "Topics_ListBySubscription",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "Topics_ListBySubscription": {
+ "$ref": "./examples/Topics_ListBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics": {
+ "get": {
+ "tags": [
+ "Topics"
+ ],
+ "summary": "List topics under a resource group.",
+ "description": "List all the topics under a resource group.",
+ "operationId": "Topics_ListByResourceGroup",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "Topics_ListByResourceGroup": {
+ "$ref": "./examples/Topics_ListByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/listKeys": {
+ "post": {
+ "tags": [
+ "Topics"
+ ],
+ "summary": "List keys for a topic.",
+ "description": "List the two keys used to publish to a topic.",
+ "operationId": "Topics_ListSharedAccessKeys",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the topic.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "Topics_ListSharedAccessKeys": {
+ "$ref": "./examples/Topics_ListSharedAccessKeys.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/regenerateKey": {
+ "post": {
+ "tags": [
+ "Topics"
+ ],
+ "summary": "Regenerate key for a topic.",
+ "description": "Regenerate a shared access key for a topic.",
+ "operationId": "Topics_RegenerateKey",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "topicName",
+ "in": "path",
+ "description": "Name of the topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "regenerateKeyRequest",
+ "in": "body",
+ "description": "Request body to regenerate key.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TopicRegenerateKeyRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TopicSharedAccessKeys"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "Topics_RegenerateKey": {
+ "$ref": "./examples/Topics_RegenerateKey.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventTypes": {
+ "get": {
+ "tags": [
+ "Topics"
+ ],
+ "summary": "List topic event types.",
+ "description": "List event types for a topic.",
+ "operationId": "Topics_ListEventTypes",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group within the user's subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "providerNamespace",
+ "in": "path",
+ "description": "Namespace of the provider of the topic.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "resourceTypeName",
+ "in": "path",
+ "description": "Name of the topic type.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "description": "Name of the topic.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "Topics_ListEventTypes": {
+ "$ref": "./examples/Topics_ListEventTypes.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.EventGrid/extensionTopics/default": {
+ "get": {
+ "tags": [
+ "Topics"
+ ],
+ "summary": "Get properties of an extension topic.",
+ "description": "Get the properties of an extension topic.",
+ "operationId": "ExtensionTopics_Get",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "scope",
+ "in": "path",
+ "description": "The identifier of the resource to which extension topic is queried. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace. 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 Azure resource.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ExtensionTopic"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "ExtensionTopics_Get": {
+ "$ref": "./examples/ExtensionTopics_Get.json"
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.EventGrid/topicTypes": {
+ "get": {
+ "tags": [
+ "TopicTypes"
+ ],
+ "summary": "List topic types.",
+ "description": "List all registered topic types.",
+ "operationId": "TopicTypes_List",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "TopicTypes_List": {
+ "$ref": "./examples/TopicTypes_List.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}": {
+ "get": {
+ "tags": [
+ "TopicTypes"
+ ],
+ "summary": "Get a topic type.",
+ "description": "Get information about a topic type.",
+ "operationId": "TopicTypes_Get",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "topicTypeName",
+ "in": "path",
+ "description": "Name of the topic type.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "TopicTypes_Get": {
+ "$ref": "./examples/TopicTypes_Get.json"
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventTypes": {
+ "get": {
+ "tags": [
+ "TopicTypes"
+ ],
+ "summary": "List event types.",
+ "description": "List event types for a topic type.",
+ "operationId": "TopicTypes_ListEventTypes",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "topicTypeName",
+ "in": "path",
+ "description": "Name of the topic type.",
+ "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."
+ }
+ },
+ "x-ms-examples": {
+ "TopicTypes_ListEventTypes": {
+ "$ref": "./examples/TopicTypes_ListEventTypes.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/providers/Microsoft.EventGrid/verifiedPartners/{verifiedPartnerName}": {
+ "get": {
+ "tags": [
+ "VerifiedPartners"
+ ],
+ "summary": "Get a verified partner.",
+ "description": "Get properties of a verified partner.",
+ "operationId": "VerifiedPartners_Get",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "verifiedPartnerName",
+ "in": "path",
+ "description": "Name of the verified partner.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VerifiedPartner"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "VerifiedPartners_Get": {
+ "$ref": "./examples/VerifiedPartners_Get.json"
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.EventGrid/verifiedPartners": {
+ "get": {
+ "tags": [
+ "VerifiedPartners"
+ ],
+ "summary": "List all verified partners.",
+ "description": "Get a list of all verified partners.",
+ "operationId": "VerifiedPartners_List",
+ "consumes": [],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/FilterParameter"
+ },
+ {
+ "$ref": "#/parameters/TopParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VerifiedPartnersListResult"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
+ }
+ },
+ "x-ms-examples": {
+ "VerifiedPartners_List": {
+ "$ref": "./examples/VerifiedPartners_List.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ChannelProperties": {
+ "description": "Properties of the Channel.",
+ "type": "object",
+ "properties": {
+ "channelType": {
+ "description": "The type of the event channel which represents the direction flow of events.",
+ "enum": [
+ "PartnerTopic",
+ "PartnerDestination"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ChannelType",
+ "modelAsString": true
+ }
+ },
+ "partnerTopicInfo": {
+ "$ref": "#/definitions/PartnerTopicInfo",
+ "description": "This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel."
+ },
+ "partnerDestinationInfo": {
+ "$ref": "#/definitions/PartnerDestinationInfo",
+ "description": "This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel."
+ },
+ "messageForActivation": {
+ "description": "Context or helpful message that can be used during the approval process by the subscriber.",
+ "type": "string"
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the channel.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Canceled",
+ "Failed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ChannelProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "readinessState": {
+ "description": "The readiness state of the corresponding partner topic.",
+ "enum": [
+ "NeverActivated",
+ "Activated"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ReadinessState",
+ "modelAsString": true
+ }
+ },
+ "expirationTimeIfNotActivatedUtc": {
+ "format": "date-time",
+ "description": "Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated,\r\nthe channel and corresponding partner topic are deleted.",
+ "type": "string"
+ }
+ }
+ },
+ "PartnerTopicInfo": {
+ "description": "Properties of the corresponding partner topic of a Channel.",
+ "type": "object",
+ "properties": {
+ "azureSubscriptionId": {
+ "description": "Azure subscription ID of the subscriber. The partner topic associated with the channel will be\r\ncreated under this Azure subscription.",
+ "type": "string"
+ },
+ "resourceGroupName": {
+ "description": "Azure Resource Group of the subscriber. The partner topic associated with the channel will be\r\ncreated under this resource group.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the partner topic associated with the channel.",
+ "type": "string"
+ },
+ "eventTypeInfo": {
+ "$ref": "#/definitions/EventTypeInfo",
+ "description": "Event Type Information for the partner topic. This information is provided by the publisher and can be used by the \r\nsubscriber to view different types of events that are published."
+ },
+ "source": {
+ "description": "The source information is provided by the publisher to determine the scope or context from which the events\r\nare originating. This information can be used by the subscriber during the approval process of the\r\ncreated partner topic.",
+ "type": "string"
+ }
+ }
+ },
+ "EventTypeInfo": {
+ "description": "The event type information for Channels.",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "description": "The kind of event type used.",
+ "enum": [
+ "Inline"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "EventDefinitionKind",
+ "modelAsString": true
+ }
+ },
+ "inlineEventTypes": {
+ "description": "A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.\r\nAn example of a valid inline event name is \"Contoso.OrderCreated\".\r\nThe inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/InlineEventProperties"
+ }
+ }
+ }
+ },
+ "ResourceMoveChangeHistory": {
+ "description": "The change history of the resource move.",
+ "type": "object",
+ "properties": {
+ "azureSubscriptionId": {
+ "description": "Azure subscription ID of the resource.",
+ "type": "string"
+ },
+ "resourceGroupName": {
+ "description": "Azure Resource Group of the resource.",
+ "type": "string"
+ },
+ "changedTimeUtc": {
+ "format": "date-time",
+ "description": "UTC timestamp of when the resource was changed.",
+ "type": "string"
+ }
+ }
+ },
+ "InlineEventProperties": {
+ "description": "Additional information about every inline event.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The description for the inline event.",
+ "type": "string"
+ },
+ "documentationUrl": {
+ "description": "The documentationUrl for the inline event.",
+ "type": "string"
+ },
+ "dataSchemaUrl": {
+ "description": "The dataSchemaUrl for the inline event.",
+ "type": "string"
+ }
+ }
+ },
+ "WebhookPartnerDestinationProperties": {
+ "description": "Properties of a partner destination webhook.",
+ "type": "object",
+ "properties": {
+ "endpointUrl": {
+ "description": "The URL that represents the endpoint of the partner destination.",
+ "type": "string"
+ },
+ "endpointBaseUrl": {
+ "description": "The base URL that represents the endpoint of the partner destination.",
+ "type": "string"
+ },
+ "clientAuthentication": {
+ "$ref": "#/definitions/PartnerClientAuthentication"
+ }
+ }
+ },
+ "AzureADPartnerClientAuthenticationProperties": {
+ "description": "Properties of an Azure Active Directory Partner Client Authentication.",
+ "type": "object",
+ "properties": {
+ "azureActiveDirectoryTenantId": {
+ "description": "The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.",
+ "type": "string"
+ },
+ "azureActiveDirectoryApplicationIdOrUri": {
+ "description": "The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.",
+ "type": "string"
+ }
+ }
+ },
+ "AzureADPartnerClientAuthentication": {
+ "description": "Azure Active Directory Partner Client Authentication",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartnerClientAuthentication"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AzureADPartnerClientAuthenticationProperties",
+ "description": "AzureAD ClientAuthentication Properties",
+ "x-ms-client-flatten": true
+ }
+ },
+ "x-ms-discriminator-value": "AzureAD"
+ },
+ "PartnerClientAuthentication": {
+ "description": "Partner client authentication",
+ "required": [
+ "clientAuthenticationType"
+ ],
+ "type": "object",
+ "properties": {
+ "clientAuthenticationType": {
+ "description": "Type of client authentication",
+ "default": "AzureAD",
+ "enum": [
+ "AzureAD"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PartnerClientAuthenticationType",
+ "modelAsString": true
+ }
+ }
+ },
+ "discriminator": "clientAuthenticationType"
+ },
+ "WebhookPartnerDestinationInfo": {
+ "description": "Information about the WebHook of the partner destination.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartnerDestinationInfo"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/WebhookPartnerDestinationProperties",
+ "description": "WebHook Properties of the partner destination.",
+ "x-ms-client-flatten": true
+ },
+ "resourceMoveChangeHistory": {
+ "description": "Change history of the resource move.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceMoveChangeHistory"
+ },
+ "x-ms-identifiers": []
+ }
+ },
+ "x-ms-discriminator-value": "WebHook"
+ },
+ "PartnerDestinationInfo": {
+ "description": "Properties of the corresponding partner destination of a Channel.",
+ "required": [
+ "endpointType"
+ ],
+ "type": "object",
+ "properties": {
+ "azureSubscriptionId": {
+ "description": "Azure subscription ID of the subscriber. The partner destination associated with the channel will be\r\ncreated under this Azure subscription.",
+ "type": "string"
+ },
+ "resourceGroupName": {
+ "description": "Azure Resource Group of the subscriber. The partner destination associated with the channel will be\r\ncreated under this resource group.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the partner destination associated with the channel.",
+ "type": "string"
+ },
+ "endpointType": {
+ "description": "Type of the endpoint for the partner destination",
+ "default": "WebHook",
+ "enum": [
+ "WebHook"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PartnerEndpointType",
+ "modelAsString": true
+ }
+ },
+ "endpointServiceContext": {
+ "description": "Additional context of the partner destination endpoint.",
+ "type": "string"
+ },
+ "resourceMoveChangeHistory": {
+ "description": "Change history of the resource move.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceMoveChangeHistory"
+ },
+ "x-ms-identifiers": []
+ }
+ },
+ "discriminator": "endpointType"
+ },
+ "Channel": {
+ "description": "Channel info.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ChannelProperties",
+ "description": "Properties of the Channel.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "description": "The system metadata relating to Channel resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ }
+ }
+ },
+ "ChannelUpdateParameters": {
+ "description": "Properties of the Channel update.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ChannelUpdateParametersProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ChannelUpdateParametersProperties": {
+ "description": "Properties of the channel update parameters.",
+ "type": "object",
+ "properties": {
+ "expirationTimeIfNotActivatedUtc": {
+ "format": "date-time",
+ "description": "Expiration time of the event channel. If this timer expires while the corresponding partner topic or partner destination is never activated,\r\nthe channel and corresponding partner topic or partner destination are deleted.",
+ "type": "string"
+ },
+ "partnerDestinationInfo": {
+ "$ref": "#/definitions/PartnerUpdateDestinationInfo",
+ "description": "Partner destination properties which can be updated if the channel is of type PartnerDestination."
+ },
+ "partnerTopicInfo": {
+ "$ref": "#/definitions/PartnerUpdateTopicInfo",
+ "description": "Partner topic properties which can be updated if the channel is of type PartnerTopic."
+ }
+ }
+ },
+ "PartnerUpdateTopicInfo": {
+ "description": "Update properties for the corresponding partner topic of a channel.",
+ "type": "object",
+ "properties": {
+ "eventTypeInfo": {
+ "$ref": "#/definitions/EventTypeInfo",
+ "description": "Event type info for the partner topic"
+ }
+ }
+ },
+ "WebhookUpdatePartnerDestinationInfo": {
+ "description": "Information about the update of the WebHook of the partner destination.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartnerUpdateDestinationInfo"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/WebhookPartnerDestinationProperties",
+ "description": "WebHook Properties of the partner destination.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "x-ms-discriminator-value": "WebHook"
+ },
+ "PartnerUpdateDestinationInfo": {
+ "description": "Properties of the corresponding partner destination of a Channel.",
+ "required": [
+ "endpointType"
+ ],
+ "type": "object",
+ "properties": {
+ "endpointType": {
+ "description": "Type of the endpoint for the partner destination",
+ "default": "WebHook",
+ "enum": [
+ "WebHook"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PartnerEndpointType",
+ "modelAsString": true
+ }
+ }
+ },
+ "discriminator": "endpointType"
+ },
+ "ChannelsListResult": {
+ "description": "Result of the List Channels operation",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A collection of Channels.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Channel"
+ }
+ },
+ "nextLink": {
+ "description": "A link for the next page of channels.",
+ "type": "string"
+ }
+ }
+ },
+ "DomainProperties": {
+ "description": "Properties of the Event Grid Domain Resource.",
+ "type": "object",
+ "properties": {
+ "privateEndpointConnections": {
+ "description": "List of private endpoint connections.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the Event Grid Domain Resource.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Canceled",
+ "Failed"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DomainProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "endpoint": {
+ "description": "Endpoint for the Event Grid Domain Resource which is used for publishing the events.",
+ "type": "string",
+ "readOnly": true
+ },
+ "inputSchema": {
+ "description": "This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.",
+ "enum": [
+ "EventGridSchema",
+ "CustomEventSchema",
+ "CloudEventSchemaV1_0"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "InputSchema",
+ "modelAsString": true
+ },
+ "default": "EventGridSchema"
+ },
+ "inputSchemaMapping": {
+ "$ref": "#/definitions/InputSchemaMapping",
+ "description": "Information about the InputSchemaMapping which specified the info about mapping event payload."
+ },
+ "metricResourceId": {
+ "description": "Metric resource id for the Event Grid Domain Resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "publicNetworkAccess": {
+ "description": "This determines if traffic is allowed over public network. By default it is enabled.\r\nYou can further restrict to specific IPs by configuring ",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ },
+ "default": "Enabled"
+ },
+ "inboundIpRules": {
+ "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/InboundIpRule"
+ },
+ "x-ms-identifiers": []
+ },
+ "disableLocalAuth": {
+ "description": "This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.",
+ "default": false,
+ "type": "boolean"
+ },
+ "autoCreateTopicWithFirstSubscription": {
+ "description": "This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.\r\nIn this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.\r\nWhen this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is\r\ncreated at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic\r\nby the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the\r\nflexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the\r\ndomain topic on demand if needed.",
+ "default": true,
+ "type": "boolean"
+ },
+ "autoDeleteTopicWithLastSubscription": {
+ "description": "This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.\r\nIn this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.\r\nWhen this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope\r\nof the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed\r\n(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full\r\ncontrol of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer\r\nresources by the user.",
+ "default": true,
+ "type": "boolean"
+ },
+ "dataResidencyBoundary": {
+ "description": "Data Residency Boundary of the resource.",
+ "enum": [
+ "WithinGeopair",
+ "WithinRegion"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataResidencyBoundary",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ResourceSku": {
+ "description": "Describes an EventGrid Resource Sku.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The Sku name of the resource. The possible values are: Basic or Premium.",
+ "default": "Basic",
+ "enum": [
+ "Basic",
+ "Premium"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Sku",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "IdentityInfo": {
+ "description": "The identity information for the resource.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.",
+ "enum": [
+ "None",
+ "SystemAssigned",
+ "UserAssigned",
+ "SystemAssigned, UserAssigned"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "IdentityType",
+ "modelAsString": true
+ }
+ },
+ "principalId": {
+ "description": "The principal ID of resource identity.",
+ "type": "string"
+ },
+ "tenantId": {
+ "description": "The tenant ID of resource.",
+ "type": "string"
+ },
+ "userAssignedIdentities": {
+ "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\r\nThis property is currently not used and reserved for future usage.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/UserIdentityProperties"
+ }
+ }
+ }
+ },
+ "InboundIpRule": {
+ "type": "object",
+ "properties": {
+ "ipMask": {
+ "description": "IP Address in CIDR notation e.g., 10.0.0.0/8.",
+ "type": "string"
+ },
+ "action": {
+ "description": "Action to perform based on the match or no match of the IpMask.",
+ "enum": [
+ "Allow"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "IpActionType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "UserIdentityProperties": {
+ "description": "The information about the user identity.",
+ "type": "object",
+ "properties": {
+ "principalId": {
+ "description": "The principal id of user assigned identity.",
+ "type": "string"
+ },
+ "clientId": {
+ "description": "The client id of user assigned identity.",
+ "type": "string"
+ }
+ }
+ },
+ "Resource": {
+ "description": "Definition of a Resource",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Fully qualified identifier of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Name of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Type of the resource.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "PrivateEndpointConnectionProperties": {
+ "description": "Properties of the private endpoint connection resource.",
+ "type": "object",
+ "properties": {
+ "privateEndpoint": {
+ "$ref": "#/definitions/PrivateEndpoint",
+ "description": "The Private Endpoint resource for this Connection."
+ },
+ "groupIds": {
+ "description": "GroupIds from the private link service resource.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "privateLinkServiceConnectionState": {
+ "$ref": "#/definitions/ConnectionState",
+ "description": "Details about the state of the connection."
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the Private Endpoint Connection.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Canceled",
+ "Failed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ResourceProvisioningState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "PrivateEndpoint": {
+ "description": "PrivateEndpoint information.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ARM identifier for Private Endpoint.",
+ "type": "string"
+ }
+ }
+ },
+ "ConnectionState": {
+ "description": "ConnectionState information.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Status of the connection.",
+ "enum": [
+ "Pending",
+ "Approved",
+ "Rejected",
+ "Disconnected"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PersistedConnectionStatus",
+ "modelAsString": true
+ }
+ },
+ "description": {
+ "description": "Description of the connection state.",
+ "type": "string"
+ },
+ "actionsRequired": {
+ "description": "Actions required (if any).",
+ "type": "string"
+ }
+ }
+ },
+ "JsonInputSchemaMappingProperties": {
+ "description": "This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "$ref": "#/definitions/JsonField",
+ "description": "The mapping information for the Id property of the Event Grid Event."
+ },
+ "topic": {
+ "$ref": "#/definitions/JsonField",
+ "description": "The mapping information for the Topic property of the Event Grid Event."
+ },
+ "eventTime": {
+ "$ref": "#/definitions/JsonField",
+ "description": "The mapping information for the EventTime property of the Event Grid Event."
+ },
+ "eventType": {
+ "$ref": "#/definitions/JsonFieldWithDefault",
+ "description": "The mapping information for the EventType property of the Event Grid Event."
+ },
+ "subject": {
+ "$ref": "#/definitions/JsonFieldWithDefault",
+ "description": "The mapping information for the Subject property of the Event Grid Event."
+ },
+ "dataVersion": {
+ "$ref": "#/definitions/JsonFieldWithDefault",
+ "description": "The mapping information for the DataVersion property of the Event Grid Event."
+ }
+ }
+ },
+ "JsonField": {
+ "description": "This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.",
+ "type": "object",
+ "properties": {
+ "sourceField": {
+ "description": "Name of a field in the input event schema that's to be used as the source of a mapping.",
+ "type": "string"
+ }
+ }
+ },
+ "JsonFieldWithDefault": {
+ "description": "This is used to express the source of an input schema mapping for a single target field\r\nin the Event Grid Event schema. This is currently used in the mappings for the 'subject',\r\n'eventtype' and 'dataversion' properties. This represents a field in the input event schema\r\nalong with a default value to be used, and at least one of these two properties should be provided.",
+ "type": "object",
+ "properties": {
+ "sourceField": {
+ "description": "Name of a field in the input event schema that's to be used as the source of a mapping.",
+ "type": "string"
+ },
+ "defaultValue": {
+ "description": "The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.",
+ "type": "string"
+ }
+ }
+ },
+ "JsonInputSchemaMapping": {
+ "description": "This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/InputSchemaMapping"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/JsonInputSchemaMappingProperties",
+ "description": "JSON Properties of the input schema mapping",
+ "x-ms-client-flatten": true
+ }
+ },
+ "x-ms-discriminator-value": "Json"
+ },
+ "InputSchemaMapping": {
+ "description": "By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.",
+ "required": [
+ "inputSchemaMappingType"
+ ],
+ "type": "object",
+ "properties": {
+ "inputSchemaMappingType": {
+ "description": "Type of the custom mapping",
+ "enum": [
+ "Json"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "InputSchemaMappingType",
+ "modelAsString": true
+ }
+ }
+ },
+ "discriminator": "inputSchemaMappingType"
+ },
+ "PrivateEndpointConnection": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties",
+ "description": "Properties of the PrivateEndpointConnection.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "TrackedResource": {
+ "description": "Definition of a Tracked Resource.",
+ "required": [
+ "location"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "location": {
+ "description": "Location of the resource.",
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "tags": {
+ "description": "Tags of the resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "Domain": {
+ "description": "EventGrid Domain.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/TrackedResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DomainProperties",
+ "description": "Properties of the Event Grid Domain resource.",
+ "x-ms-client-flatten": true
+ },
+ "sku": {
+ "$ref": "#/definitions/ResourceSku",
+ "description": "The Sku pricing tier for the Event Grid Domain resource."
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityInfo",
+ "description": "Identity information for the Event Grid Domain resource."
+ },
+ "systemData": {
+ "description": "The system metadata relating to the Event Grid Domain resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ }
+ }
+ },
+ "DomainUpdateParameters": {
+ "description": "Properties of the Domain update.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "Tags of the domains resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "properties": {
+ "$ref": "#/definitions/DomainUpdateParameterProperties",
+ "description": "Properties of the resource.",
+ "x-ms-client-flatten": true
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityInfo",
+ "description": "Identity information for the resource."
+ },
+ "sku": {
+ "$ref": "#/definitions/ResourceSku",
+ "description": "The Sku pricing tier for the domain."
+ }
+ }
+ },
+ "DomainUpdateParameterProperties": {
+ "description": "Information of domain update parameter properties.",
+ "type": "object",
+ "properties": {
+ "publicNetworkAccess": {
+ "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ },
+ "default": "Enabled"
+ },
+ "inboundIpRules": {
+ "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/InboundIpRule"
+ },
+ "x-ms-identifiers": []
+ },
+ "disableLocalAuth": {
+ "description": "This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.",
+ "type": "boolean"
+ },
+ "autoCreateTopicWithFirstSubscription": {
+ "description": "This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.\r\nIn this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.\r\nWhen this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is\r\ncreated at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic\r\nby the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the\r\nflexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the\r\ndomain topic on demand if needed.",
+ "type": "boolean"
+ },
+ "autoDeleteTopicWithLastSubscription": {
+ "description": "This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.\r\nIn this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.\r\nWhen this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope\r\nof the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed\r\n(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full\r\ncontrol of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer\r\nresources by the user.",
+ "type": "boolean"
+ },
+ "dataResidencyBoundary": {
+ "description": "The data residency boundary for the domain.",
+ "enum": [
+ "WithinGeopair",
+ "WithinRegion"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataResidencyBoundary",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "DomainsListResult": {
+ "description": "Result of the List Domains operation",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A collection of Domains",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Domain"
+ }
+ },
+ "nextLink": {
+ "description": "A link for the next page of domains",
+ "type": "string"
+ }
+ }
+ },
+ "DomainSharedAccessKeys": {
+ "description": "Shared access keys of the Domain.",
+ "type": "object",
+ "properties": {
+ "key1": {
+ "description": "Shared access key1 for the domain.",
+ "type": "string"
+ },
+ "key2": {
+ "description": "Shared access key2 for the domain.",
+ "type": "string"
+ }
+ }
+ },
+ "DomainRegenerateKeyRequest": {
+ "description": "Domain regenerate share access key request.",
+ "required": [
+ "keyName"
+ ],
+ "type": "object",
+ "properties": {
+ "keyName": {
+ "description": "Key name to regenerate key1 or key2.",
+ "type": "string"
+ }
+ }
+ },
+ "DomainTopicProperties": {
+ "description": "Properties of the Domain Topic.",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state of the domain topic.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Canceled",
+ "Failed"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DomainTopicProvisioningState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "DomainTopic": {
+ "description": "Domain Topic.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DomainTopicProperties",
+ "description": "Properties of the Domain Topic.",
+ "readOnly": true,
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "description": "The system metadata relating to Domain Topic resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ }
+ }
+ },
+ "DomainTopicsListResult": {
+ "description": "Result of the List Domain Topics operation.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A collection of Domain Topics.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DomainTopic"
+ }
+ },
+ "nextLink": {
+ "description": "A link for the next page of domain topics.",
+ "type": "string"
+ }
+ }
+ },
+ "EventChannelProperties": {
+ "description": "Properties of the Event Channel.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "#/definitions/EventChannelSource",
+ "description": "Source of the event channel. This represents a unique resource in the partner's resource model."
+ },
+ "destination": {
+ "$ref": "#/definitions/EventChannelDestination",
+ "description": "Represents the destination of an event channel."
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the event channel.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Canceled",
+ "Failed"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "EventChannelProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "partnerTopicReadinessState": {
+ "description": "The readiness state of the corresponding partner topic.",
+ "enum": [
+ "NotActivatedByUserYet",
+ "ActivatedByUser",
+ "DeactivatedByUser",
+ "DeletedByUser"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "PartnerTopicReadinessState",
+ "modelAsString": true
+ }
+ },
+ "expirationTimeIfNotActivatedUtc": {
+ "format": "date-time",
+ "description": "Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated,\r\nthe event channel and corresponding partner topic are deleted.",
+ "type": "string"
+ },
+ "filter": {
+ "$ref": "#/definitions/EventChannelFilter",
+ "description": "Information about the filter for the event channel."
+ },
+ "partnerTopicFriendlyDescription": {
+ "description": "Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic.\r\nThis will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.",
+ "type": "string"
+ }
+ }
+ },
+ "EventChannelSource": {
+ "description": "Properties of the source of an event channel.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "description": "The identifier of the resource that's the source of the events.\r\nThis represents a unique resource in the partner's resource model.",
+ "type": "string"
+ }
+ }
+ },
+ "EventChannelDestination": {
+ "description": "Properties of the destination of an event channel.",
+ "type": "object",
+ "properties": {
+ "azureSubscriptionId": {
+ "description": "Azure subscription ID of the customer creating the event channel. The partner topic\r\nassociated with the event channel will be created under this Azure subscription.",
+ "type": "string"
+ },
+ "resourceGroup": {
+ "description": "Azure Resource Group of the customer creating the event channel. The partner topic\r\nassociated with the event channel will be created under this resource group.",
+ "type": "string"
+ },
+ "partnerTopicName": {
+ "description": "Name of the partner topic associated with the event channel.",
+ "type": "string"
+ }
+ }
+ },
+ "EventChannelFilter": {
+ "description": "Filter for the Event Channel.",
+ "type": "object",
+ "properties": {
+ "enableAdvancedFilteringOnArrays": {
+ "description": "Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. The default value is either false or null.",
+ "default": false,
+ "type": "boolean"
+ },
+ "advancedFilters": {
+ "description": "An array of advanced filters that are used for filtering event channels.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AdvancedFilter"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "NumberInAdvancedFilter": {
+ "description": "NumberIn Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "values": {
+ "description": "The set of filter values.",
+ "type": "array",
+ "items": {
+ "format": "double",
+ "type": "number"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "NumberIn"
+ },
+ "NumberNotInAdvancedFilter": {
+ "description": "NumberNotIn Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "values": {
+ "description": "The set of filter values.",
+ "type": "array",
+ "items": {
+ "format": "double",
+ "type": "number"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "NumberNotIn"
+ },
+ "NumberLessThanAdvancedFilter": {
+ "description": "NumberLessThan Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "value": {
+ "format": "double",
+ "description": "The filter value.",
+ "type": "number"
+ }
+ },
+ "x-ms-discriminator-value": "NumberLessThan"
+ },
+ "NumberGreaterThanAdvancedFilter": {
+ "description": "NumberGreaterThan Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "value": {
+ "format": "double",
+ "description": "The filter value.",
+ "type": "number"
+ }
+ },
+ "x-ms-discriminator-value": "NumberGreaterThan"
+ },
+ "NumberLessThanOrEqualsAdvancedFilter": {
+ "description": "NumberLessThanOrEquals Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "value": {
+ "format": "double",
+ "description": "The filter value.",
+ "type": "number"
+ }
+ },
+ "x-ms-discriminator-value": "NumberLessThanOrEquals"
+ },
+ "NumberGreaterThanOrEqualsAdvancedFilter": {
+ "description": "NumberGreaterThanOrEquals Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "value": {
+ "format": "double",
+ "description": "The filter value.",
+ "type": "number"
+ }
+ },
+ "x-ms-discriminator-value": "NumberGreaterThanOrEquals"
+ },
+ "BoolEqualsAdvancedFilter": {
+ "description": "BoolEquals Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "value": {
+ "description": "The boolean filter value.",
+ "type": "boolean"
+ }
+ },
+ "x-ms-discriminator-value": "BoolEquals"
+ },
+ "StringInAdvancedFilter": {
+ "description": "StringIn Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "values": {
+ "description": "The set of filter values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "StringIn"
+ },
+ "StringNotInAdvancedFilter": {
+ "description": "StringNotIn Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "values": {
+ "description": "The set of filter values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "StringNotIn"
+ },
+ "StringBeginsWithAdvancedFilter": {
+ "description": "StringBeginsWith Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "values": {
+ "description": "The set of filter values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "StringBeginsWith"
+ },
+ "StringEndsWithAdvancedFilter": {
+ "description": "StringEndsWith Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "values": {
+ "description": "The set of filter values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "StringEndsWith"
+ },
+ "StringContainsAdvancedFilter": {
+ "description": "StringContains Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "values": {
+ "description": "The set of filter values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "StringContains"
+ },
+ "NumberInRangeAdvancedFilter": {
+ "description": "NumberInRange Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "values": {
+ "description": "The set of filter values.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "format": "double",
+ "type": "number"
+ }
+ }
+ }
+ },
+ "x-ms-discriminator-value": "NumberInRange"
+ },
+ "NumberNotInRangeAdvancedFilter": {
+ "description": "NumberNotInRange Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "values": {
+ "description": "The set of filter values.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "format": "double",
+ "type": "number"
+ }
+ }
+ }
+ },
+ "x-ms-discriminator-value": "NumberNotInRange"
+ },
+ "StringNotBeginsWithAdvancedFilter": {
+ "description": "StringNotBeginsWith Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "values": {
+ "description": "The set of filter values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "StringNotBeginsWith"
+ },
+ "StringNotEndsWithAdvancedFilter": {
+ "description": "StringNotEndsWith Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "values": {
+ "description": "The set of filter values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "StringNotEndsWith"
+ },
+ "StringNotContainsAdvancedFilter": {
+ "description": "StringNotContains Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {
+ "values": {
+ "description": "The set of filter values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "StringNotContains"
+ },
+ "IsNullOrUndefinedAdvancedFilter": {
+ "description": "IsNullOrUndefined Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {},
+ "x-ms-discriminator-value": "IsNullOrUndefined"
+ },
+ "IsNotNullAdvancedFilter": {
+ "description": "IsNotNull Advanced Filter.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AdvancedFilter"
+ }
+ ],
+ "properties": {},
+ "x-ms-discriminator-value": "IsNotNull"
+ },
+ "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.",
+ "required": [
+ "operatorType"
+ ],
+ "type": "object",
+ "properties": {
+ "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",
+ "NumberInRange",
+ "NumberNotInRange",
+ "StringNotBeginsWith",
+ "StringNotEndsWith",
+ "StringNotContains",
+ "IsNullOrUndefined",
+ "IsNotNull"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AdvancedFilterOperatorType",
+ "modelAsString": true
+ }
+ },
+ "key": {
+ "description": "The field/property in the event based on which you want to filter.",
+ "type": "string"
+ }
+ },
+ "discriminator": "operatorType"
+ },
+ "EventChannel": {
+ "description": "Event Channel.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/EventChannelProperties",
+ "description": "Properties of the EventChannel.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "description": "The system metadata relating to Event Channel resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ }
+ }
+ },
+ "EventChannelsListResult": {
+ "description": "Result of the List Event Channels operation",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A collection of Event Channels",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EventChannel"
+ }
+ },
+ "nextLink": {
+ "description": "A link for the next page of event channels",
+ "type": "string"
+ }
+ }
+ },
+ "EventSubscriptionProperties": {
+ "description": "Properties of the Event Subscription.",
+ "type": "object",
+ "properties": {
+ "topic": {
+ "description": "Name of the topic of the event subscription.",
+ "type": "string",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the event subscription.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Canceled",
+ "Failed",
+ "AwaitingManualAction"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "EventSubscriptionProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "destination": {
+ "$ref": "#/definitions/EventSubscriptionDestination",
+ "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering."
+ },
+ "deliveryWithResourceIdentity": {
+ "$ref": "#/definitions/DeliveryWithResourceIdentity",
+ "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering."
+ },
+ "filter": {
+ "$ref": "#/definitions/EventSubscriptionFilter",
+ "description": "Information about the filter for the event subscription."
+ },
+ "labels": {
+ "description": "List of user defined labels.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "expirationTimeUtc": {
+ "format": "date-time",
+ "description": "Expiration time of the event subscription.",
+ "type": "string"
+ },
+ "eventDeliverySchema": {
+ "description": "The event delivery schema for the event subscription.",
+ "default": "EventGridSchema",
+ "enum": [
+ "EventGridSchema",
+ "CustomInputSchema",
+ "CloudEventSchemaV1_0"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "EventDeliverySchema",
+ "modelAsString": true
+ }
+ },
+ "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."
+ },
+ "deadLetterDestination": {
+ "$ref": "#/definitions/DeadLetterDestination",
+ "description": "The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.\r\nUses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering."
+ },
+ "deadLetterWithResourceIdentity": {
+ "$ref": "#/definitions/DeadLetterWithResourceIdentity",
+ "description": "The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.\r\nUses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering."
+ }
+ }
+ },
+ "DeliveryWithResourceIdentity": {
+ "description": "Information about the delivery for an event subscription with resource identity.",
+ "type": "object",
+ "properties": {
+ "identity": {
+ "$ref": "#/definitions/EventSubscriptionIdentity",
+ "description": "The identity to use when delivering events."
+ },
+ "destination": {
+ "$ref": "#/definitions/EventSubscriptionDestination",
+ "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering."
+ }
+ }
+ },
+ "EventSubscriptionFilter": {
+ "description": "Filter for the Event Subscription.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "isSubjectCaseSensitive": {
+ "description": "Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter\r\nshould be compared in a case sensitive manner.",
+ "default": false,
+ "type": "boolean"
+ },
+ "enableAdvancedFilteringOnArrays": {
+ "description": "Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.",
+ "type": "boolean"
+ },
+ "advancedFilters": {
+ "description": "An array of advanced filters that are used for filtering event subscriptions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AdvancedFilter"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "RetryPolicy": {
+ "description": "Information about the retry policy for an event subscription.",
+ "type": "object",
+ "properties": {
+ "maxDeliveryAttempts": {
+ "format": "int32",
+ "description": "Maximum number of delivery retry attempts for events.",
+ "default": 30,
+ "type": "integer"
+ },
+ "eventTimeToLiveInMinutes": {
+ "format": "int32",
+ "description": "Time To Live (in minutes) for events.",
+ "default": 1440,
+ "type": "integer"
+ }
+ }
+ },
+ "DeadLetterWithResourceIdentity": {
+ "description": "Information about the deadletter destination with resource identity.",
+ "type": "object",
+ "properties": {
+ "identity": {
+ "$ref": "#/definitions/EventSubscriptionIdentity",
+ "description": "The identity to use when dead-lettering events."
+ },
+ "deadLetterDestination": {
+ "$ref": "#/definitions/DeadLetterDestination",
+ "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering."
+ }
+ }
+ },
+ "EventSubscriptionIdentity": {
+ "description": "The identity information with the event subscription.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.",
+ "enum": [
+ "SystemAssigned",
+ "UserAssigned"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "EventSubscriptionIdentityType",
+ "modelAsString": true
+ }
+ },
+ "userAssignedIdentity": {
+ "description": "The user identity associated with the resource.",
+ "type": "string"
+ }
+ }
+ },
+ "WebHookEventSubscriptionDestinationProperties": {
+ "description": "Information about the webhook destination properties for an event subscription.",
+ "type": "object",
+ "properties": {
+ "endpointUrl": {
+ "description": "The URL that represents the endpoint of the destination of an event subscription.",
+ "type": "string",
+ "x-ms-secret": true
+ },
+ "endpointBaseUrl": {
+ "description": "The base URL that represents the endpoint of the destination of an event subscription.",
+ "type": "string",
+ "readOnly": true
+ },
+ "maxEventsPerBatch": {
+ "format": "int32",
+ "description": "Maximum number of events per batch.",
+ "default": 1,
+ "type": "integer"
+ },
+ "preferredBatchSizeInKilobytes": {
+ "format": "int32",
+ "description": "Preferred batch size in Kilobytes.",
+ "default": 64,
+ "type": "integer"
+ },
+ "azureActiveDirectoryTenantId": {
+ "description": "The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.",
+ "type": "string"
+ },
+ "azureActiveDirectoryApplicationIdOrUri": {
+ "description": "The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.",
+ "type": "string"
+ },
+ "deliveryAttributeMappings": {
+ "description": "Delivery attribute details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeliveryAttributeMapping"
+ }
+ }
+ }
+ },
+ "StorageBlobDeadLetterDestinationProperties": {
+ "description": "Properties of the storage blob based dead letter destination.",
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "description": "The Azure Resource ID of the storage account that is the destination of the deadletter events",
+ "type": "string"
+ },
+ "blobContainerName": {
+ "description": "The name of the Storage blob container that is the destination of the deadletter events",
+ "type": "string"
+ }
+ }
+ },
+ "StaticDeliveryAttributeMappingProperties": {
+ "description": "Properties of static delivery attribute mapping.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Value of the delivery attribute.",
+ "type": "string"
+ },
+ "isSecret": {
+ "description": "Boolean flag to tell if the attribute contains sensitive information .",
+ "type": "boolean",
+ "default": false
+ }
+ }
+ },
+ "StaticDeliveryAttributeMapping": {
+ "description": "Static delivery attribute mapping details.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryAttributeMapping"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/StaticDeliveryAttributeMappingProperties",
+ "description": "Properties of static delivery attribute mapping.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "x-ms-discriminator-value": "Static"
+ },
+ "DynamicDeliveryAttributeMappingProperties": {
+ "description": "Properties of dynamic delivery attribute mapping.",
+ "type": "object",
+ "properties": {
+ "sourceField": {
+ "description": "JSON path in the event which contains attribute value.",
+ "type": "string"
+ }
+ }
+ },
+ "DynamicDeliveryAttributeMapping": {
+ "description": "Dynamic delivery attribute mapping details.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeliveryAttributeMapping"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DynamicDeliveryAttributeMappingProperties",
+ "description": "Properties of dynamic delivery attribute mapping.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "x-ms-discriminator-value": "Dynamic"
+ },
+ "DeliveryAttributeMapping": {
+ "description": "Delivery attribute mapping details.",
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the delivery attribute or header.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of the delivery attribute or header name.",
+ "enum": [
+ "Static",
+ "Dynamic"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DeliveryAttributeMappingType",
+ "modelAsString": true
+ }
+ }
+ },
+ "discriminator": "type"
+ },
+ "StorageBlobDeadLetterDestination": {
+ "description": "Information about the storage blob based dead letter destination.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeadLetterDestination"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/StorageBlobDeadLetterDestinationProperties",
+ "description": "The properties of the Storage Blob based deadletter destination",
+ "x-ms-client-flatten": true
+ }
+ },
+ "x-ms-discriminator-value": "StorageBlob"
+ },
+ "WebHookEventSubscriptionDestination": {
+ "description": "Information about the webhook destination for an event subscription.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EventSubscriptionDestination"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/WebHookEventSubscriptionDestinationProperties",
+ "description": "WebHook Properties of the event subscription destination.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "x-ms-discriminator-value": "WebHook"
+ },
+ "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.",
+ "required": [
+ "endpointType"
+ ],
+ "type": "object",
+ "properties": {
+ "endpointType": {
+ "description": "Type of the endpoint for the dead letter destination",
+ "enum": [
+ "StorageBlob"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DeadLetterEndPointType",
+ "modelAsString": true
+ }
+ }
+ },
+ "discriminator": "endpointType"
+ },
+ "EventHubEventSubscriptionDestinationProperties": {
+ "description": "The properties for a event hub destination.",
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "description": "The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.",
+ "type": "string"
+ },
+ "deliveryAttributeMappings": {
+ "description": "Delivery attribute details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeliveryAttributeMapping"
+ }
+ }
+ }
+ },
+ "EventHubEventSubscriptionDestination": {
+ "description": "Information about the event hub destination for an event subscription.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EventSubscriptionDestination"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/EventHubEventSubscriptionDestinationProperties",
+ "description": "Event Hub Properties of the event subscription destination.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "x-ms-discriminator-value": "EventHub"
+ },
+ "StorageQueueEventSubscriptionDestinationProperties": {
+ "description": "The properties for a storage queue destination.",
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "description": "The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.",
+ "type": "string"
+ },
+ "queueName": {
+ "description": "The name of the Storage queue under a storage account that is the destination of an event subscription.",
+ "type": "string"
+ },
+ "queueMessageTimeToLiveInSeconds": {
+ "format": "int64",
+ "description": "Storage queue message time to live in seconds.",
+ "type": "integer"
+ }
+ }
+ },
+ "StorageQueueEventSubscriptionDestination": {
+ "description": "Information about the storage queue destination for an event subscription.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EventSubscriptionDestination"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/StorageQueueEventSubscriptionDestinationProperties",
+ "description": "Storage Queue Properties of the event subscription destination.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "x-ms-discriminator-value": "StorageQueue"
+ },
+ "HybridConnectionEventSubscriptionDestinationProperties": {
+ "description": "The properties for a hybrid connection destination.",
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "description": "The Azure Resource ID of an hybrid connection that is the destination of an event subscription.",
+ "type": "string"
+ },
+ "deliveryAttributeMappings": {
+ "description": "Delivery attribute details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeliveryAttributeMapping"
+ }
+ }
+ }
+ },
+ "HybridConnectionEventSubscriptionDestination": {
+ "description": "Information about the HybridConnection destination for an event subscription.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EventSubscriptionDestination"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/HybridConnectionEventSubscriptionDestinationProperties",
+ "description": "Hybrid connection Properties of the event subscription destination.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "x-ms-discriminator-value": "HybridConnection"
+ },
+ "ServiceBusQueueEventSubscriptionDestinationProperties": {
+ "description": "The properties that represent the Service Bus destination of an event subscription.",
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "description": "The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription.",
+ "type": "string"
+ },
+ "deliveryAttributeMappings": {
+ "description": "Delivery attribute details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeliveryAttributeMapping"
+ }
+ }
+ }
+ },
+ "ServiceBusQueueEventSubscriptionDestination": {
+ "description": "Information about the service bus destination for an event subscription.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EventSubscriptionDestination"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ServiceBusQueueEventSubscriptionDestinationProperties",
+ "description": "Service Bus Properties of the event subscription destination.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "x-ms-discriminator-value": "ServiceBusQueue"
+ },
+ "ServiceBusTopicEventSubscriptionDestinationProperties": {
+ "description": "The properties that represent the Service Bus Topic destination of an event subscription.",
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "description": "The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription.",
+ "type": "string"
},
- "tags": {
- "description": "Tags of the resource.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
+ "deliveryAttributeMappings": {
+ "description": "Delivery attribute details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeliveryAttributeMapping"
}
}
}
},
- "Domain": {
- "description": "EventGrid Domain.",
+ "ServiceBusTopicEventSubscriptionDestination": {
+ "description": "Information about the service bus topic destination for an event subscription.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/TrackedResource"
+ "$ref": "#/definitions/EventSubscriptionDestination"
}
],
"properties": {
"properties": {
- "$ref": "#/definitions/DomainProperties",
- "description": "Properties of the domain.",
+ "$ref": "#/definitions/ServiceBusTopicEventSubscriptionDestinationProperties",
+ "description": "Service Bus Topic Properties of the event subscription destination.",
"x-ms-client-flatten": true
}
- }
+ },
+ "x-ms-discriminator-value": "ServiceBusTopic"
},
- "DomainUpdateParameters": {
- "description": "Properties of the Domain update.",
+ "AzureFunctionEventSubscriptionDestinationProperties": {
+ "description": "The properties that represent the Azure Function destination of an event subscription.",
"type": "object",
"properties": {
- "tags": {
- "description": "Tags of the domains resource.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
+ "resourceId": {
+ "description": "The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription.",
+ "type": "string"
+ },
+ "maxEventsPerBatch": {
+ "format": "int32",
+ "description": "Maximum number of events per batch.",
+ "default": 1,
+ "type": "integer"
+ },
+ "preferredBatchSizeInKilobytes": {
+ "format": "int32",
+ "description": "Preferred batch size in Kilobytes.",
+ "default": 64,
+ "type": "integer"
+ },
+ "deliveryAttributeMappings": {
+ "description": "Delivery attribute details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeliveryAttributeMapping"
}
}
}
},
- "DomainsListResult": {
- "description": "Result of the List Domains operation.",
+ "AzureFunctionEventSubscriptionDestination": {
+ "description": "Information about the azure function destination for an event subscription.",
"type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EventSubscriptionDestination"
+ }
+ ],
"properties": {
- "value": {
- "description": "A collection of Domains.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/Domain"
- }
- },
- "nextLink": {
- "description": "A link for the next page of domains.",
- "type": "string"
+ "properties": {
+ "$ref": "#/definitions/AzureFunctionEventSubscriptionDestinationProperties",
+ "description": "Azure Function Properties of the event subscription destination.",
+ "x-ms-client-flatten": true
}
- }
+ },
+ "x-ms-discriminator-value": "AzureFunction"
},
- "DomainSharedAccessKeys": {
- "description": "Shared access keys of the Domain.",
+ "PartnerEventSubscriptionDestinationProperties": {
"type": "object",
"properties": {
- "key1": {
- "description": "Shared access key1 for the domain.",
- "type": "string"
- },
- "key2": {
- "description": "Shared access key2 for the domain.",
+ "resourceId": {
+ "description": "The Azure Resource Id that represents the endpoint of a Partner Destination of an event subscription.",
"type": "string"
}
}
},
- "DomainRegenerateKeyRequest": {
- "description": "Domain regenerate share access key request.",
- "required": [
- "keyName"
- ],
+ "PartnerEventSubscriptionDestination": {
"type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EventSubscriptionDestination"
+ }
+ ],
"properties": {
- "keyName": {
- "description": "Key name to regenerate key1 or key2.",
- "type": "string"
+ "properties": {
+ "$ref": "#/definitions/PartnerEventSubscriptionDestinationProperties",
+ "description": "Partner Destination Properties of the event subscription destination.",
+ "x-ms-client-flatten": true
}
- }
+ },
+ "x-ms-discriminator-value": "PartnerDestination"
},
- "DomainTopicProperties": {
- "description": "Properties of the Domain Topic.",
+ "EventSubscriptionDestination": {
+ "description": "Information about the destination for an event subscription.",
+ "required": [
+ "endpointType"
+ ],
"type": "object",
"properties": {
- "provisioningState": {
- "description": "Provisioning state of the domain topic.",
+ "endpointType": {
+ "description": "Type of the endpoint for the event subscription destination.",
"enum": [
- "Creating",
- "Updating",
- "Deleting",
- "Succeeded",
- "Canceled",
- "Failed"
+ "WebHook",
+ "EventHub",
+ "StorageQueue",
+ "HybridConnection",
+ "ServiceBusQueue",
+ "ServiceBusTopic",
+ "AzureFunction",
+ "PartnerDestination"
],
"type": "string",
"x-ms-enum": {
- "name": "DomainTopicProvisioningState",
+ "name": "EndpointType",
"modelAsString": true
}
}
- }
+ },
+ "discriminator": "endpointType"
},
- "DomainTopic": {
- "description": "Domain Topic.",
+ "EventSubscription": {
+ "description": "Event Subscription",
"type": "object",
"allOf": [
{
@@ -2485,59 +10519,29 @@
],
"properties": {
"properties": {
- "$ref": "#/definitions/DomainTopicProperties",
- "description": "Properties of the Domain Topic.",
+ "$ref": "#/definitions/EventSubscriptionProperties",
+ "description": "Properties of the event subscription.",
"x-ms-client-flatten": true
- }
- }
- },
- "DomainTopicsListResult": {
- "description": "Result of the List Domain Topics operation.",
- "type": "object",
- "properties": {
- "value": {
- "description": "A collection of Domain Topics.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/DomainTopic"
- }
},
- "nextLink": {
- "description": "A link for the next page of domain topics.",
- "type": "string"
+ "systemData": {
+ "description": "The system metadata relating to Event Subscription resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
}
}
},
- "EventSubscriptionProperties": {
- "description": "Properties of the Event Subscription",
+ "EventSubscriptionUpdateParameters": {
+ "description": "Properties of the Event Subscription update.",
"type": "object",
"properties": {
- "topic": {
- "description": "Name of the topic of the event subscription.",
- "type": "string",
- "readOnly": true
- },
- "provisioningState": {
- "description": "Provisioning state of the event subscription.",
- "enum": [
- "Creating",
- "Updating",
- "Deleting",
- "Succeeded",
- "Canceled",
- "Failed",
- "AwaitingManualAction"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "EventSubscriptionProvisioningState",
- "modelAsString": true
- }
- },
"destination": {
"$ref": "#/definitions/EventSubscriptionDestination",
- "description": "Information about the destination where events have to be delivered for the event subscription."
+ "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering."
+ },
+ "deliveryWithResourceIdentity": {
+ "$ref": "#/definitions/DeliveryWithResourceIdentity",
+ "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering."
},
"filter": {
"$ref": "#/definitions/EventSubscriptionFilter",
@@ -2552,683 +10556,1110 @@
},
"expirationTimeUtc": {
"format": "date-time",
- "description": "Expiration time of the event subscription.",
+ "description": "Information about the expiration time for the event subscription.",
"type": "string"
},
+ "eventDeliverySchema": {
+ "description": "The event delivery schema for the event subscription.",
+ "enum": [
+ "EventGridSchema",
+ "CustomInputSchema",
+ "CloudEventSchemaV1_0"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "EventDeliverySchema",
+ "modelAsString": true
+ }
+ },
"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."
},
"deadLetterDestination": {
"$ref": "#/definitions/DeadLetterDestination",
- "description": "The DeadLetter destination of the event subscription."
+ "description": "The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.\r\nUses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering."
+ },
+ "deadLetterWithResourceIdentity": {
+ "$ref": "#/definitions/DeadLetterWithResourceIdentity",
+ "description": "The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.\r\nUses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering."
+ }
+ }
+ },
+ "EventSubscriptionFullUrl": {
+ "description": "Full endpoint url of an event subscription",
+ "type": "object",
+ "properties": {
+ "endpointUrl": {
+ "description": "The URL that represents the endpoint of the destination of an event subscription.",
+ "type": "string"
+ }
+ }
+ },
+ "EventSubscriptionsListResult": {
+ "description": "Result of the List EventSubscriptions operation",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A collection of EventSubscriptions",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EventSubscription"
+ }
+ },
+ "nextLink": {
+ "description": "A link for the next page of event subscriptions",
+ "type": "string"
+ }
+ }
+ },
+ "DeliveryAttributeListResult": {
+ "description": "Result of the Get delivery attributes operation.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A collection of DeliveryAttributeMapping",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeliveryAttributeMapping"
+ }
+ }
+ }
+ },
+ "OperationsListResult": {
+ "description": "Result of the List Operations operation",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A collection of operations",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Operation"
+ }
+ }
+ }
+ },
+ "Operation": {
+ "description": "Represents an operation returned by the GetOperations request.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the operation.",
+ "type": "string"
+ },
+ "display": {
+ "$ref": "#/definitions/OperationInfo",
+ "description": "Display name of the operation."
+ },
+ "origin": {
+ "description": "Origin of the operation.",
+ "type": "string"
+ },
+ "isDataAction": {
+ "description": "This Boolean is used to determine if the operation is a data plane action or not.",
+ "type": "boolean"
+ },
+ "properties": {
+ "description": "Properties of the operation.",
+ "type": "object",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "OperationInfo": {
+ "description": "Information about an operation",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "Name of the provider",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Name of the resource type",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Name of the operation",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the operation",
+ "type": "string"
}
}
},
- "EventSubscriptionFilter": {
- "description": "Filter for the Event Subscription.",
+ "PartnerConfigurationProperties": {
+ "description": "Properties of the partner configuration.",
"type": "object",
"properties": {
- "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"
- },
- "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.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "partnerAuthorization": {
+ "$ref": "#/definitions/PartnerAuthorization",
+ "description": "The details of authorized partners."
},
- "isSubjectCaseSensitive": {
- "description": "Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter \r\nshould be compared in a case sensitive manner.",
- "default": false,
- "type": "boolean"
- },
- "advancedFilters": {
- "description": "An array of advanced filters that are used for filtering event subscriptions.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/AdvancedFilter"
+ "provisioningState": {
+ "description": "Provisioning state of the partner configuration.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Canceled",
+ "Failed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PartnerConfigurationProvisioningState",
+ "modelAsString": true
}
}
}
},
- "RetryPolicy": {
- "description": "Information about the retry policy for an event subscription.",
+ "PartnerAuthorization": {
+ "description": "The partner authorization details.",
"type": "object",
"properties": {
- "maxDeliveryAttempts": {
+ "defaultMaximumExpirationTimeInDays": {
"format": "int32",
- "description": "Maximum number of delivery retry attempts for events.",
+ "description": "Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is\r\nnot specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days.",
"type": "integer"
},
- "eventTimeToLiveInMinutes": {
- "format": "int32",
- "description": "Time To Live (in minutes) for events.",
- "type": "integer"
+ "authorizedPartnersList": {
+ "description": "The list of authorized partners.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Partner"
+ },
+ "x-ms-identifiers": []
}
}
},
- "WebHookEventSubscriptionDestinationProperties": {
- "description": "Information about the webhook destination properties for an event subscription.",
+ "Partner": {
+ "description": "Information about the partner.",
"type": "object",
"properties": {
- "endpointUrl": {
- "description": "The URL that represents the endpoint of the destination of an event subscription.",
+ "partnerRegistrationImmutableId": {
+ "format": "uuid",
+ "description": "The immutableId of the corresponding partner registration.",
"type": "string"
},
- "endpointBaseUrl": {
- "description": "The base URL that represents the endpoint of the destination of an event subscription.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "StorageBlobDeadLetterDestinationProperties": {
- "description": "Properties of the storage blob based dead letter destination.",
- "type": "object",
- "properties": {
- "resourceId": {
- "description": "The Azure Resource ID of the storage account that is the destination of the deadletter events",
+ "partnerName": {
+ "description": "The partner name.",
"type": "string"
},
- "blobContainerName": {
- "description": "The name of the Storage blob container that is the destination of the deadletter events",
+ "authorizationExpirationTimeInUtc": {
+ "format": "date-time",
+ "description": "Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's\r\ncontext will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration.\r\nIf not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified.",
"type": "string"
}
}
},
- "NumberInAdvancedFilter": {
- "description": "NumberIn Advanced Filter.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/AdvancedFilter"
- }
- ],
- "properties": {
- "values": {
- "description": "The set of filter values.",
- "type": "array",
- "items": {
- "format": "double",
- "type": "number"
- }
- }
- },
- "x-ms-discriminator-value": "NumberIn"
- },
- "StorageBlobDeadLetterDestination": {
- "description": "Information about the storage blob based dead letter destination.",
+ "PartnerConfiguration": {
+ "description": "Partner configuration information",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/DeadLetterDestination"
+ "$ref": "#/definitions/Resource"
}
],
"properties": {
"properties": {
- "$ref": "#/definitions/StorageBlobDeadLetterDestinationProperties",
- "description": "The properties of the Storage Blob based deadletter destination",
+ "$ref": "#/definitions/PartnerConfigurationProperties",
+ "description": "Properties of the partner configuration.",
"x-ms-client-flatten": true
+ },
+ "systemData": {
+ "description": "The system metadata relating to partner configuration resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ },
+ "location": {
+ "description": "Location of the resource.",
+ "type": "string"
+ },
+ "tags": {
+ "description": "Tags of the resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
}
- },
- "x-ms-discriminator-value": "StorageBlob"
+ }
},
- "NumberNotInAdvancedFilter": {
- "description": "NumberNotIn Advanced Filter.",
+ "PartnerConfigurationUpdateParameters": {
+ "description": "Properties of the partner configuration update.",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/AdvancedFilter"
- }
- ],
"properties": {
- "values": {
- "description": "The set of filter values.",
- "type": "array",
- "items": {
- "format": "double",
- "type": "number"
+ "tags": {
+ "description": "Tags of the partner configuration resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
}
+ },
+ "properties": {
+ "$ref": "#/definitions/PartnerConfigurationUpdateParameterProperties",
+ "description": "Properties of the Topic resource.",
+ "x-ms-client-flatten": true
}
- },
- "x-ms-discriminator-value": "NumberNotIn"
+ }
},
- "NumberLessThanAdvancedFilter": {
- "description": "NumberLessThan Advanced Filter.",
+ "PartnerConfigurationUpdateParameterProperties": {
+ "description": "Information of partner configuration update parameter properties.",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/AdvancedFilter"
- }
- ],
"properties": {
- "value": {
- "format": "double",
- "description": "The filter value.",
- "type": "number"
+ "defaultMaximumExpirationTimeInDays": {
+ "format": "int32",
+ "description": "The default time used to validate the maximum expiration time for each authorized partners in days. Allowed values ar between 1 and 365 days.",
+ "type": "integer"
}
- },
- "x-ms-discriminator-value": "NumberLessThan"
+ }
},
- "NumberGreaterThanAdvancedFilter": {
- "description": "NumberGreaterThan Advanced Filter.",
+ "PartnerConfigurationsListResult": {
+ "description": "Result of the List partner configurations operation",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/AdvancedFilter"
- }
- ],
"properties": {
"value": {
- "format": "double",
- "description": "The filter value.",
- "type": "number"
+ "description": "A collection of partner configurations.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PartnerConfiguration"
+ }
+ },
+ "nextLink": {
+ "description": "A link for the next page of partner configurations.",
+ "type": "string"
}
- },
- "x-ms-discriminator-value": "NumberGreaterThan"
+ }
},
- "NumberLessThanOrEqualsAdvancedFilter": {
- "description": "NumberLessThanOrEquals Advanced Filter.",
+ "PartnerDestinationProperties": {
+ "description": "Properties of the Partner Destination.",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/AdvancedFilter"
- }
- ],
"properties": {
- "value": {
- "format": "double",
- "description": "The filter value.",
- "type": "number"
+ "partnerRegistrationImmutableId": {
+ "format": "uuid",
+ "description": "The immutable Id of the corresponding partner registration.",
+ "type": "string"
+ },
+ "endpointServiceContext": {
+ "description": "Endpoint context associated with this partner destination.",
+ "type": "string"
+ },
+ "expirationTimeIfNotActivatedUtc": {
+ "format": "date-time",
+ "description": "Expiration time of the partner destination. If this timer expires and the partner destination was never activated,\r\nthe partner destination and corresponding channel are deleted.",
+ "type": "string"
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the partner destination.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Canceled",
+ "Failed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PartnerDestinationProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "activationState": {
+ "description": "Activation state of the partner destination.",
+ "enum": [
+ "NeverActivated",
+ "Activated"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PartnerDestinationActivationState",
+ "modelAsString": true
+ }
+ },
+ "endpointBaseUrl": {
+ "description": "Endpoint Base URL of the partner destination",
+ "type": "string"
+ },
+ "messageForActivation": {
+ "description": "Context or helpful message that can be used during the approval process.",
+ "type": "string"
}
- },
- "x-ms-discriminator-value": "NumberLessThanOrEquals"
+ }
},
- "NumberGreaterThanOrEqualsAdvancedFilter": {
- "description": "NumberGreaterThanOrEquals Advanced Filter.",
+ "PartnerDestination": {
+ "description": "Event Grid Partner Destination.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/AdvancedFilter"
+ "$ref": "#/definitions/TrackedResource"
}
],
"properties": {
- "value": {
- "format": "double",
- "description": "The filter value.",
- "type": "number"
+ "properties": {
+ "$ref": "#/definitions/PartnerDestinationProperties",
+ "description": "Properties of the Partner Destination.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "description": "The system metadata relating to Partner Destination resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
}
- },
- "x-ms-discriminator-value": "NumberGreaterThanOrEquals"
+ }
},
- "BoolEqualsAdvancedFilter": {
- "description": "BoolEquals Advanced Filter.",
+ "PartnerDestinationUpdateParameters": {
+ "description": "Properties of the Partner Destination that can be updated.",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/AdvancedFilter"
- }
- ],
"properties": {
- "value": {
- "description": "The boolean filter value.",
- "type": "boolean"
- }
- },
- "x-ms-discriminator-value": "BoolEquals"
- },
- "StringInAdvancedFilter": {
- "description": "StringIn Advanced Filter.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/AdvancedFilter"
+ "tags": {
+ "description": "Tags of the Partner Destination resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
}
- ],
+ }
+ },
+ "PartnerDestinationsListResult": {
+ "description": "Result of the List Partner Destinations operation.",
+ "type": "object",
"properties": {
- "values": {
- "description": "The set of filter values.",
+ "value": {
+ "description": "A collection of partner destinations.",
"type": "array",
"items": {
- "type": "string"
+ "$ref": "#/definitions/PartnerDestination"
}
+ },
+ "nextLink": {
+ "description": "A link for the next page of partner destinations.",
+ "type": "string"
}
- },
- "x-ms-discriminator-value": "StringIn"
+ }
},
- "StringNotInAdvancedFilter": {
- "description": "StringNotIn Advanced Filter.",
+ "PartnerNamespaceProperties": {
+ "description": "Properties of the partner namespace.",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/AdvancedFilter"
- }
- ],
"properties": {
- "values": {
- "description": "The set of filter values.",
+ "privateEndpointConnections": {
"type": "array",
"items": {
- "type": "string"
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the partner namespace.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Canceled",
+ "Failed"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "PartnerNamespaceProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "partnerRegistrationFullyQualifiedId": {
+ "description": "The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format:\r\n/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.",
+ "type": "string"
+ },
+ "endpoint": {
+ "description": "Endpoint for the partner namespace.",
+ "type": "string",
+ "readOnly": true
+ },
+ "publicNetworkAccess": {
+ "description": "This determines if traffic is allowed over public network. By default it is enabled.\r\nYou can further restrict to specific IPs by configuring ",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ },
+ "default": "Enabled"
+ },
+ "inboundIpRules": {
+ "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/InboundIpRule"
+ },
+ "x-ms-identifiers": []
+ },
+ "disableLocalAuth": {
+ "description": "This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.",
+ "default": false,
+ "type": "boolean"
+ },
+ "partnerTopicRoutingMode": {
+ "description": "This determines if events published to this partner namespace should use the source attribute in the event payload\r\nor use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.",
+ "default": "SourceEventAttribute",
+ "enum": [
+ "SourceEventAttribute",
+ "ChannelNameHeader"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PartnerTopicRoutingMode",
+ "modelAsString": true
}
}
- },
- "x-ms-discriminator-value": "StringNotIn"
+ }
},
- "StringBeginsWithAdvancedFilter": {
- "description": "StringBeginsWith Advanced Filter.",
+ "PartnerNamespace": {
+ "description": "EventGrid Partner Namespace.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/AdvancedFilter"
+ "$ref": "#/definitions/TrackedResource"
}
],
"properties": {
- "values": {
- "description": "The set of filter values.",
- "type": "array",
- "items": {
+ "properties": {
+ "$ref": "#/definitions/PartnerNamespaceProperties",
+ "description": "Properties of the Partner Namespace.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "description": "The system metadata relating to Partner Namespace resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ }
+ }
+ },
+ "PartnerNamespaceUpdateParameters": {
+ "description": "Properties of the Partner Namespace update.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "Tags of the Partner Namespace.",
+ "type": "object",
+ "additionalProperties": {
"type": "string"
}
+ },
+ "properties": {
+ "$ref": "#/definitions/PartnerNamespaceUpdateParameterProperties",
+ "description": "Properties of the Partner Namespace.",
+ "x-ms-client-flatten": true
}
- },
- "x-ms-discriminator-value": "StringBeginsWith"
+ }
},
- "StringEndsWithAdvancedFilter": {
- "description": "StringEndsWith Advanced Filter.",
+ "PartnerNamespaceUpdateParameterProperties": {
+ "description": "Information of Partner Namespace update parameter properties.",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/AdvancedFilter"
- }
- ],
"properties": {
- "values": {
- "description": "The set of filter values.",
+ "publicNetworkAccess": {
+ "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ },
+ "default": "Enabled"
+ },
+ "inboundIpRules": {
+ "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.",
"type": "array",
"items": {
- "type": "string"
- }
+ "$ref": "#/definitions/InboundIpRule"
+ },
+ "x-ms-identifiers": []
+ },
+ "disableLocalAuth": {
+ "description": "This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.",
+ "type": "boolean"
}
- },
- "x-ms-discriminator-value": "StringEndsWith"
+ }
},
- "StringContainsAdvancedFilter": {
- "description": "StringContains Advanced Filter.",
+ "PartnerNamespacesListResult": {
+ "description": "Result of the List Partner Namespaces operation",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/AdvancedFilter"
- }
- ],
"properties": {
- "values": {
- "description": "The set of filter values.",
+ "value": {
+ "description": "A collection of partner namespaces.",
"type": "array",
"items": {
- "type": "string"
+ "$ref": "#/definitions/PartnerNamespace"
}
+ },
+ "nextLink": {
+ "description": "A link for the next page of partner namespaces.",
+ "type": "string"
}
- },
- "x-ms-discriminator-value": "StringContains"
+ }
},
- "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.",
+ "PartnerNamespaceSharedAccessKeys": {
+ "description": "Shared access keys of the partner namespace.",
+ "type": "object",
+ "properties": {
+ "key1": {
+ "description": "Shared access key1 for the partner namespace.",
+ "type": "string"
+ },
+ "key2": {
+ "description": "Shared access key2 for the partner namespace.",
+ "type": "string"
+ }
+ }
+ },
+ "PartnerNamespaceRegenerateKeyRequest": {
+ "description": "PartnerNamespace regenerate shared access key request.",
"required": [
- "operatorType"
+ "keyName"
],
"type": "object",
"properties": {
- "operatorType": {
- "description": "The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.",
+ "keyName": {
+ "description": "Key name to regenerate (key1 or key2).",
+ "type": "string"
+ }
+ }
+ },
+ "PartnerRegistrationProperties": {
+ "description": "Properties of the partner registration.",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state of the partner registration.",
"enum": [
- "NumberIn",
- "NumberNotIn",
- "NumberLessThan",
- "NumberGreaterThan",
- "NumberLessThanOrEquals",
- "NumberGreaterThanOrEquals",
- "BoolEquals",
- "StringIn",
- "StringNotIn",
- "StringBeginsWith",
- "StringEndsWith",
- "StringContains"
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Canceled",
+ "Failed"
],
"type": "string",
+ "readOnly": true,
"x-ms-enum": {
- "name": "AdvancedFilterOperatorType",
+ "name": "PartnerRegistrationProvisioningState",
"modelAsString": true
}
},
- "key": {
- "description": "The field/property in the event based on which you want to filter.",
+ "partnerRegistrationImmutableId": {
+ "format": "uuid",
+ "description": "The immutableId of the corresponding partner registration.",
+ "type": "string"
+ },
+ "partnerName": {
+ "description": "Official name of the partner name. For example: \"Contoso\".",
+ "type": "string"
+ },
+ "partnerResourceTypeName": {
+ "description": "Name of the partner resource type.",
+ "type": "string"
+ },
+ "partnerResourceTypeDisplayName": {
+ "description": "Display name of the partner resource type.",
+ "type": "string"
+ },
+ "partnerResourceTypeDescription": {
+ "description": "Short description of the partner resource type. The length of this description should not exceed 256 characters.",
+ "type": "string"
+ },
+ "longDescription": {
+ "description": "Long description for the custom scenarios and integration to be displayed in the portal if needed.\r\nLength of this description should not exceed 2048 characters.",
+ "type": "string"
+ },
+ "partnerCustomerServiceNumber": {
+ "description": "The customer service number of the publisher. The expected phone format should start with a '+' sign \r\nfollowed by the country code. The remaining digits are then followed. Only digits and spaces are allowed and its\r\nlength cannot exceed 16 digits including country code. Examples of valid phone numbers are: +1 515 123 4567 and\r\n+966 7 5115 2471. Examples of invalid phone numbers are: +1 (515) 123-4567, 1 515 123 4567 and +966 121 5115 24 7 551 1234 43",
+ "type": "string"
+ },
+ "partnerCustomerServiceExtension": {
+ "description": "The extension of the customer service number of the publisher. Only digits are allowed and number of digits should not exceed 10.",
+ "type": "string"
+ },
+ "customerServiceUri": {
+ "description": "The extension of the customer service URI of the publisher.",
+ "type": "string"
+ },
+ "setupUri": {
+ "description": "URI of the partner website that can be used by Azure customers to setup Event Grid\r\nintegration on an event source.",
+ "type": "string"
+ },
+ "logoUri": {
+ "description": "URI of the logo.",
"type": "string"
+ },
+ "visibilityState": {
+ "description": "Visibility state of the partner registration.",
+ "enum": [
+ "Hidden",
+ "PublicPreview",
+ "GenerallyAvailable"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PartnerRegistrationVisibilityState",
+ "modelAsString": true
+ }
+ },
+ "authorizedAzureSubscriptionIds": {
+ "description": "List of Azure subscription Ids that are authorized to create a partner namespace\r\nassociated with this partner registration. This is an optional property. Creating\r\npartner namespaces is always permitted under the same Azure subscription as the one used\r\nfor creating the partner registration.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
- },
- "discriminator": "operatorType"
+ }
},
- "WebHookEventSubscriptionDestination": {
- "description": "Information about the webhook destination for an event subscription",
+ "PartnerRegistration": {
+ "description": "Information about a partner registration.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/EventSubscriptionDestination"
+ "$ref": "#/definitions/TrackedResource"
}
],
"properties": {
"properties": {
- "$ref": "#/definitions/WebHookEventSubscriptionDestinationProperties",
- "description": "WebHook Properties of the event subscription destination",
+ "$ref": "#/definitions/PartnerRegistrationProperties",
+ "description": "Properties of the partner registration.",
"x-ms-client-flatten": true
+ },
+ "systemData": {
+ "description": "The system metadata relating to Partner Registration resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
}
- },
- "x-ms-discriminator-value": "WebHook"
+ }
},
- "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.",
+ "PartnerRegistrationUpdateParameters": {
+ "description": "Properties of the Partner Registration update.",
"type": "object",
- "required": [
- "endpointType"
- ],
"properties": {
- "endpointType": {
- "description": "Type of the endpoint for the dead letter destination",
- "enum": [
- "StorageBlob"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "DeadLetterEndPointType",
- "modelAsString": true
+ "tags": {
+ "description": "Tags of the partner registration resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "partnerTopicTypeName": {
+ "description": "Name of the partner topic type.",
+ "type": "string"
+ },
+ "partnerTopicTypeDisplayName": {
+ "description": "Display name of the partner topic type.",
+ "type": "string"
+ },
+ "partnerTopicTypeDescription": {
+ "description": "Description of the partner topic type.",
+ "type": "string"
+ },
+ "setupUri": {
+ "description": "URI of the partner website that can be used by Azure customers to setup Event Grid\r\nintegration on an event source.",
+ "type": "string"
+ },
+ "logoUri": {
+ "description": "URI of the partner logo.",
+ "type": "string"
+ },
+ "authorizedAzureSubscriptionIds": {
+ "description": "List of IDs of Azure AD applications that are authorized to create a partner namespace\r\nassociated with this partner registration. This is an optional property. Creating\r\npartner namespaces is always permitted under the same Azure subscription as the one used\r\nfor creating the partner registration.",
+ "type": "array",
+ "items": {
+ "type": "string"
}
}
- },
- "discriminator": "endpointType"
+ }
},
- "EventHubEventSubscriptionDestinationProperties": {
- "description": "The properties for a event hub destination.",
+ "PartnerRegistrationsListResult": {
+ "description": "Result of the List Partner Registrations operation.",
"type": "object",
"properties": {
- "resourceId": {
- "description": "The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.",
+ "value": {
+ "description": "A collection of partner registrations.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PartnerRegistration"
+ }
+ },
+ "nextLink": {
+ "description": "A link for the next page of partner registrations.",
"type": "string"
}
}
},
- "EventHubEventSubscriptionDestination": {
- "description": "Information about the event hub destination for an event subscription",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/EventSubscriptionDestination"
- }
- ],
- "properties": {
- "properties": {
- "$ref": "#/definitions/EventHubEventSubscriptionDestinationProperties",
- "description": "Event Hub Properties of the event subscription destination",
- "x-ms-client-flatten": true
- }
- },
- "x-ms-discriminator-value": "EventHub"
- },
- "StorageQueueEventSubscriptionDestinationProperties": {
- "description": "The properties for a storage queue destination.",
+ "EventTypeProperties": {
+ "description": "Properties of the event type",
"type": "object",
"properties": {
- "resourceId": {
- "description": "The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.",
+ "displayName": {
+ "description": "Display name of the event type.",
"type": "string"
},
- "queueName": {
- "description": "The name of the Storage queue under a storage account that is the destination of an event subscription.",
+ "description": {
+ "description": "Description of the event type.",
+ "type": "string"
+ },
+ "schemaUrl": {
+ "description": "Url of the schema for this event type.",
"type": "string"
+ },
+ "isInDefaultSet": {
+ "description": "IsInDefaultSet flag of the event type.",
+ "type": "boolean"
}
}
},
- "StorageQueueEventSubscriptionDestination": {
- "description": "Information about the storage queue destination for an event subscription.",
+ "EventType": {
+ "description": "Event Type for a subject under a topic",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/EventSubscriptionDestination"
+ "$ref": "#/definitions/Resource"
}
],
"properties": {
"properties": {
- "$ref": "#/definitions/StorageQueueEventSubscriptionDestinationProperties",
- "description": "Storage Queue Properties of the event subscription destination",
+ "$ref": "#/definitions/EventTypeProperties",
+ "description": "Properties of the event type.",
"x-ms-client-flatten": true
}
- },
- "x-ms-discriminator-value": "StorageQueue"
+ }
},
- "HybridConnectionEventSubscriptionDestinationProperties": {
- "description": "The properties for a hybrid connection destination.",
+ "PartnerTopicUpdateParameters": {
+ "description": "Properties of the Partner Topic update.",
"type": "object",
"properties": {
- "resourceId": {
- "description": "The Azure Resource ID of an hybrid connection that is the destination of an event subscription.",
+ "tags": {
+ "description": "Tags of the Partner Topic resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityInfo",
+ "description": "Identity information for the Partner Topic resource."
+ }
+ }
+ },
+ "PartnerTopicProperties": {
+ "description": "Properties of the Partner Topic.",
+ "type": "object",
+ "properties": {
+ "partnerRegistrationImmutableId": {
+ "format": "uuid",
+ "description": "The immutableId of the corresponding partner registration.",
+ "type": "string"
+ },
+ "source": {
+ "description": "Source associated with this partner topic. This represents a unique partner resource.",
+ "type": "string"
+ },
+ "eventTypeInfo": {
+ "$ref": "#/definitions/EventTypeInfo",
+ "description": "Event Type information from the corresponding event channel."
+ },
+ "expirationTimeIfNotActivatedUtc": {
+ "format": "date-time",
+ "description": "Expiration time of the partner topic. If this timer expires while the partner topic is still never activated,\r\nthe partner topic and corresponding event channel are deleted.",
+ "type": "string"
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the partner topic.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Canceled",
+ "Failed"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "PartnerTopicProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "activationState": {
+ "description": "Activation state of the partner topic.",
+ "enum": [
+ "NeverActivated",
+ "Activated",
+ "Deactivated"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PartnerTopicActivationState",
+ "modelAsString": true
+ }
+ },
+ "partnerTopicFriendlyDescription": {
+ "description": "Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic.\r\nThis will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.",
+ "type": "string"
+ },
+ "messageForActivation": {
+ "description": "Context or helpful message that can be used during the approval process by the subscriber.",
"type": "string"
}
}
},
- "HybridConnectionEventSubscriptionDestination": {
- "description": "Information about the HybridConnection destination for an event subscription.",
+ "PartnerTopic": {
+ "description": "Event Grid Partner Topic.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/EventSubscriptionDestination"
+ "$ref": "#/definitions/TrackedResource"
}
],
"properties": {
"properties": {
- "$ref": "#/definitions/HybridConnectionEventSubscriptionDestinationProperties",
- "description": "Hybrid connection Properties of the event subscription destination",
+ "$ref": "#/definitions/PartnerTopicProperties",
+ "description": "Properties of the Partner Topic.",
"x-ms-client-flatten": true
+ },
+ "systemData": {
+ "description": "The system metadata relating to Partner Topic resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityInfo",
+ "description": "Identity information for the Partner Topic resource."
}
- },
- "x-ms-discriminator-value": "HybridConnection"
+ }
},
- "ServiceBusQueueEventSubscriptionDestinationProperties": {
- "description": "The properties that represent the Service Bus destination of an event subscription.",
+ "PartnerTopicsListResult": {
+ "description": "Result of the List Partner Topics operation.",
"type": "object",
"properties": {
- "resourceId": {
- "description": "The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription.",
+ "value": {
+ "description": "A collection of partner topics.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PartnerTopic"
+ }
+ },
+ "nextLink": {
+ "description": "A link for the next page of partner topics.",
"type": "string"
}
}
},
- "ServiceBusQueueEventSubscriptionDestination": {
- "description": "Information about the service bus destination for an event subscription",
+ "EventTypesListResult": {
+ "description": "Result of the List Event Types operation",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/EventSubscriptionDestination"
- }
- ],
"properties": {
- "properties": {
- "$ref": "#/definitions/ServiceBusQueueEventSubscriptionDestinationProperties",
- "description": "Service Bus Properties of the event subscription destination",
- "x-ms-client-flatten": true
+ "value": {
+ "description": "A collection of event types",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EventType"
+ }
}
- },
- "x-ms-discriminator-value": "ServiceBusQueue"
+ }
},
- "EventSubscriptionDestination": {
- "description": "Information about the destination for an event subscription",
+ "PrivateEndpointConnectionListResult": {
+ "description": "Result of the list of all private endpoint connections operation.",
"type": "object",
- "required": [
- "endpointType"
- ],
"properties": {
- "endpointType": {
- "description": "Type of the endpoint for the event subscription destination",
- "enum": [
- "WebHook",
- "EventHub",
- "StorageQueue",
- "HybridConnection",
- "ServiceBusQueue"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "EndpointType",
- "modelAsString": true
+ "value": {
+ "description": "A collection of private endpoint connection resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
}
+ },
+ "nextLink": {
+ "description": "A link for the next page of private endpoint connection resources.",
+ "type": "string"
}
- },
- "discriminator": "endpointType"
+ }
},
- "EventSubscription": {
- "description": "Event Subscription",
+ "PrivateLinkResource": {
+ "description": "Information of the private link resource.",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/Resource"
- }
- ],
"properties": {
"properties": {
- "$ref": "#/definitions/EventSubscriptionProperties",
- "description": "Properties of the event subscription",
+ "$ref": "#/definitions/PrivateLinkResourceProperties",
+ "description": "Properties of the private link resource.",
"x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "Fully qualified identifier of the resource.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the resource.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of the resource.",
+ "type": "string"
}
}
},
- "EventSubscriptionUpdateParameters": {
- "description": "Properties of the Event Subscription update",
+ "PrivateLinkResourceProperties": {
"type": "object",
"properties": {
- "destination": {
- "$ref": "#/definitions/EventSubscriptionDestination",
- "description": "Information about the destination where events have to be delivered for the event subscription."
+ "groupId": {
+ "type": "string"
},
- "filter": {
- "$ref": "#/definitions/EventSubscriptionFilter",
- "description": "Information about the filter for the event subscription."
+ "displayName": {
+ "type": "string"
},
- "labels": {
- "description": "List of user defined labels.",
+ "requiredMembers": {
"type": "array",
"items": {
"type": "string"
}
},
- "expirationTimeUtc": {
- "format": "date-time",
- "description": "Information about the expiration time for the event subscription.",
- "type": "string"
- },
- "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."
- },
- "deadLetterDestination": {
- "$ref": "#/definitions/DeadLetterDestination",
- "description": "The DeadLetter destination of the event subscription."
+ "requiredZoneNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
}
},
- "EventSubscriptionFullUrl": {
- "description": "Full endpoint url of an event subscription",
+ "PrivateLinkResourcesListResult": {
+ "description": "Result of the List private link resources operation.",
"type": "object",
"properties": {
- "endpointUrl": {
- "description": "The URL that represents the endpoint of the destination of an event subscription.",
+ "value": {
+ "description": "A collection of private link resources",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ },
+ "nextLink": {
+ "description": "A link for the next page of private link resources.",
"type": "string"
}
}
},
- "EventSubscriptionsListResult": {
- "description": "Result of the List EventSubscriptions operation",
+ "SystemTopicProperties": {
+ "description": "Properties of the System Topic.",
"type": "object",
"properties": {
- "value": {
- "description": "A collection of EventSubscriptions",
- "type": "array",
- "items": {
- "$ref": "#/definitions/EventSubscription"
+ "provisioningState": {
+ "description": "Provisioning state of the system topic.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Canceled",
+ "Failed"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ResourceProvisioningState",
+ "modelAsString": true
}
},
- "nextLink": {
- "description": "A link for the next page of event subscriptions",
+ "source": {
+ "description": "Source for the system topic.",
+ "type": "string"
+ },
+ "topicType": {
+ "description": "TopicType for the system topic.",
"type": "string"
+ },
+ "metricResourceId": {
+ "description": "Metric resource id for the system topic.",
+ "type": "string",
+ "readOnly": true
}
}
},
- "OperationsListResult": {
- "description": "Result of the List Operations operation",
+ "SystemTopic": {
+ "description": "EventGrid System Topic.",
"type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/TrackedResource"
+ }
+ ],
"properties": {
- "value": {
- "description": "A collection of operations",
- "type": "array",
- "items": {
- "$ref": "#/definitions/Operation"
- }
+ "properties": {
+ "$ref": "#/definitions/SystemTopicProperties",
+ "description": "Properties of the system topic.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "description": "The system metadata relating to System Topic resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityInfo",
+ "description": "Identity information for the resource."
}
}
},
- "Operation": {
- "description": "Represents an operation returned by the GetOperations request",
+ "SystemTopicUpdateParameters": {
+ "description": "Properties of the System Topic update.",
"type": "object",
"properties": {
- "name": {
- "description": "Name of the operation",
- "type": "string"
- },
- "display": {
- "$ref": "#/definitions/OperationInfo",
- "description": "Display name of the operation"
- },
- "origin": {
- "description": "Origin of the operation",
- "type": "string"
- },
- "properties": {
- "description": "Properties of the operation",
+ "tags": {
+ "description": "Tags of the system topic.",
"type": "object",
- "x-ms-client-flatten": true
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityInfo",
+ "description": "Resource identity information."
}
}
},
- "OperationInfo": {
- "description": "Information about an operation",
+ "SystemTopicsListResult": {
+ "description": "Result of the List System topics operation.",
"type": "object",
"properties": {
- "provider": {
- "description": "Name of the provider",
- "type": "string"
- },
- "resource": {
- "description": "Name of the resource type",
- "type": "string"
- },
- "operation": {
- "description": "Name of the operation",
- "type": "string"
+ "value": {
+ "description": "A collection of system Topics.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SystemTopic"
+ }
},
- "description": {
- "description": "Description of the operation",
+ "nextLink": {
+ "description": "A link for the next page of topics.",
"type": "string"
}
}
},
"TopicProperties": {
- "description": "Properties of the Topic",
+ "description": "Properties of the Topic.",
"type": "object",
"properties": {
+ "privateEndpointConnections": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "readOnly": true
+ },
"provisioningState": {
"description": "Provisioning state of the topic.",
"enum": [
@@ -3250,6 +11681,81 @@
"description": "Endpoint for the topic.",
"type": "string",
"readOnly": true
+ },
+ "inputSchema": {
+ "description": "This determines the format that Event Grid should expect for incoming events published to the topic.",
+ "enum": [
+ "EventGridSchema",
+ "CustomEventSchema",
+ "CloudEventSchemaV1_0"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "InputSchema",
+ "modelAsString": true
+ },
+ "default": "EventGridSchema"
+ },
+ "inputSchemaMapping": {
+ "$ref": "#/definitions/InputSchemaMapping",
+ "description": "This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema."
+ },
+ "metricResourceId": {
+ "description": "Metric resource id for the topic.",
+ "type": "string",
+ "readOnly": true
+ },
+ "publicNetworkAccess": {
+ "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ },
+ "default": "Enabled"
+ },
+ "inboundIpRules": {
+ "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/InboundIpRule"
+ },
+ "x-ms-identifiers": []
+ },
+ "disableLocalAuth": {
+ "description": "This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic.",
+ "default": false,
+ "type": "boolean"
+ },
+ "dataResidencyBoundary": {
+ "description": "Data Residency Boundary of the resource.",
+ "enum": [
+ "WithinGeopair",
+ "WithinRegion"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataResidencyBoundary",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ExtendedLocation": {
+ "description": "Definition of an Extended Location",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Fully qualified name of the extended location.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of the extended location.",
+ "type": "string"
}
}
},
@@ -3264,8 +11770,39 @@
"properties": {
"properties": {
"$ref": "#/definitions/TopicProperties",
- "description": "Properties of the topic",
+ "description": "Properties of the topic.",
"x-ms-client-flatten": true
+ },
+ "sku": {
+ "$ref": "#/definitions/ResourceSku",
+ "description": "The Sku pricing tier for the topic."
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityInfo",
+ "description": "Identity information for the resource."
+ },
+ "kind": {
+ "description": "Kind of the resource.",
+ "enum": [
+ "Azure",
+ "AzureArc"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ResourceKind",
+ "modelAsString": true
+ },
+ "default": "Azure"
+ },
+ "extendedLocation": {
+ "$ref": "#/definitions/ExtendedLocation",
+ "description": "Extended location of the resource."
+ },
+ "systemData": {
+ "description": "The system metadata relating to Topic resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
}
}
},
@@ -3274,11 +11811,67 @@
"type": "object",
"properties": {
"tags": {
- "description": "Tags of the resource",
+ "description": "Tags of the Topic resource.",
"type": "object",
"additionalProperties": {
"type": "string"
}
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityInfo",
+ "description": "Topic resource identity information."
+ },
+ "properties": {
+ "$ref": "#/definitions/TopicUpdateParameterProperties",
+ "description": "Properties of the Topic resource.",
+ "x-ms-client-flatten": true
+ },
+ "sku": {
+ "$ref": "#/definitions/ResourceSku",
+ "description": "The Sku pricing tier for the topic."
+ }
+ }
+ },
+ "TopicUpdateParameterProperties": {
+ "description": "Information of topic update parameter properties.",
+ "type": "object",
+ "properties": {
+ "publicNetworkAccess": {
+ "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ },
+ "default": "Enabled"
+ },
+ "inboundIpRules": {
+ "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/InboundIpRule"
+ },
+ "x-ms-identifiers": []
+ },
+ "disableLocalAuth": {
+ "description": "This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic.",
+ "type": "boolean"
+ },
+ "dataResidencyBoundary": {
+ "description": "The data residency boundary for the topic.",
+ "enum": [
+ "WithinGeopair",
+ "WithinRegion"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataResidencyBoundary",
+ "modelAsString": true
+ }
}
}
},
@@ -3326,43 +11919,22 @@
}
}
},
- "EventTypesListResult": {
- "description": "Result of the List Event Types operation",
- "type": "object",
- "properties": {
- "value": {
- "description": "A collection of event types",
- "type": "array",
- "items": {
- "$ref": "#/definitions/EventType"
- }
- }
- }
- },
- "EventTypeProperties": {
- "description": "Properties of the event type",
+ "ExtensionTopicProperties": {
+ "description": "Properties of the Extension Topic",
"type": "object",
"properties": {
- "displayName": {
- "description": "Display name of the event type.",
- "type": "string"
- },
"description": {
- "description": "Description of the event type.",
+ "description": "Description of the extension topic.",
"type": "string"
},
- "schemaUrl": {
- "description": "Url of the schema for this event type.",
+ "systemTopic": {
+ "description": "System topic resource id which is mapped to the source.",
"type": "string"
- },
- "isInDefaultSet": {
- "description": "IsInDefaultSet flag of the event type.",
- "type": "boolean"
}
}
},
- "EventType": {
- "description": "Event Type for a subject under a topic",
+ "ExtensionTopic": {
+ "description": "Event grid Extension Topic. This is used for getting Event Grid related metrics for Azure resources.",
"type": "object",
"allOf": [
{
@@ -3371,9 +11943,15 @@
],
"properties": {
"properties": {
- "$ref": "#/definitions/EventTypeProperties",
- "description": "Properties of the event type.",
+ "$ref": "#/definitions/ExtensionTopicProperties",
+ "description": "Properties of the extension topic",
"x-ms-client-flatten": true
+ },
+ "systemData": {
+ "description": "The system metadata relating to Extension Topic resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
}
}
},
@@ -3440,6 +12018,27 @@
"items": {
"type": "string"
}
+ },
+ "sourceResourceFormat": {
+ "description": "Source resource format.",
+ "type": "string"
+ },
+ "supportedScopesForSource": {
+ "description": "Supported source scopes.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "Resource",
+ "ResourceGroup",
+ "AzureSubscription",
+ "ManagementGroup"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TopicTypeSourceScope",
+ "modelAsString": true
+ }
+ }
}
}
},
@@ -3458,6 +12057,106 @@
"x-ms-client-flatten": true
}
}
+ },
+ "VerifiedPartnerProperties": {
+ "description": "Properties of the verified partner.",
+ "type": "object",
+ "properties": {
+ "partnerRegistrationImmutableId": {
+ "format": "uuid",
+ "description": "ImmutableId of the corresponding partner registration.",
+ "type": "string"
+ },
+ "organizationName": {
+ "description": "Official name of the Partner.",
+ "type": "string"
+ },
+ "partnerDisplayName": {
+ "description": "Display name of the verified partner.",
+ "type": "string"
+ },
+ "partnerTopicDetails": {
+ "$ref": "#/definitions/PartnerDetails",
+ "description": "Details of the partner topic scenario."
+ },
+ "partnerDestinationDetails": {
+ "$ref": "#/definitions/PartnerDetails",
+ "description": "Details of the partner destination scenario."
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the verified partner.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Canceled",
+ "Failed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "VerifiedPartnerProvisioningState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "PartnerDetails": {
+ "description": "Information about the partner.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "This is short description about the partner. The length of this description should not exceed 256 characters.",
+ "type": "string"
+ },
+ "longDescription": {
+ "description": "Long description for the partner's scenarios and integration.Length of this description should not exceed 2048 characters.",
+ "type": "string"
+ },
+ "setupUri": {
+ "description": "URI of the partner website that can be used by Azure customers to setup Event Grid\r\nintegration on an event source.",
+ "type": "string"
+ }
+ }
+ },
+ "VerifiedPartner": {
+ "description": "Verified partner information",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/VerifiedPartnerProperties",
+ "description": "Properties of the verified partner.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "description": "The system metadata relating to Verified Partner resource.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ }
+ }
+ },
+ "VerifiedPartnersListResult": {
+ "description": "Result of the List verified partners operation",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A collection of verified partners.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VerifiedPartner"
+ }
+ },
+ "nextLink": {
+ "description": "A link for the next page of verified partners if any.",
+ "type": "string"
+ }
+ }
}
},
"parameters": {
@@ -3489,6 +12188,7 @@
"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.",
"required": false,
"type": "integer",
+ "format": "int32",
"x-ms-parameter-location": "method"
}
},
@@ -3503,4 +12203,4 @@
}
}
}
-}
+}
\ No newline at end of file