{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Topics API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Topics", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Post Topics Topicname:publish", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/topics/:topicName:publish", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "topicName", "value": "", "type": "path", "description": "Topic Name." } ] }, "docs": "Publish Single Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error. " }, { "info": { "name": "Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:receive", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/topics/:topicName/eventsubscriptions/:eventSubscriptionName:receive", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "topicName", "value": "", "type": "path", "description": "Topic Name." }, { "name": "eventSubscriptionName", "value": "", "type": "path", "description": "Event Subscription Name." }, { "name": "maxEvents", "value": "", "type": "query", "description": "Max Events count to be received. Minimum value is 1, while maximum value is 100 events. If not specified, the default value is 1." }, { "name": "maxWaitTime", "value": "", "type": "query", "description": "Max wait time value for receive operation in Seconds. It is the time in seconds that the server approximately waits for the availability of an event and responds to the request. If an event is available, the broker responds immediately to the client. Minimum value is 10 seconds, while maximum value is 120 seconds. If not specified, the default value is 60 seconds." } ] }, "docs": "Receive Batch of Cloud Events from the Event Subscription." }, { "info": { "name": "Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:acknowledge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/topics/:topicName/eventsubscriptions/:eventSubscriptionName:acknowledge", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "topicName", "value": "", "type": "path", "description": "Topic Name." }, { "name": "eventSubscriptionName", "value": "", "type": "path", "description": "Event Subscription Name." } ] }, "docs": "Acknowledge batch of Cloud Events. The server responds with an HTTP 200 status code if the request is successfully accepted. The response body will include the set of successfully acknowledged lockTokens, along with other failed lockTokens with their corresponding error information. Successfully acknowledged events will no longer be available to any consumer." }, { "info": { "name": "Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:release", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/topics/:topicName/eventsubscriptions/:eventSubscriptionName:release", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "topicName", "value": "", "type": "path", "description": "Topic Name." }, { "name": "eventSubscriptionName", "value": "", "type": "path", "description": "Event Subscription Name." }, { "name": "releaseDelayInSeconds", "value": "", "type": "query", "description": "Release cloud events with the specified delay in seconds." } ] }, "docs": "Release batch of Cloud Events. The server responds with an HTTP 200 status code if the request is successfully accepted. The response body will include the set of successfully released lockTokens, along with other failed lockTokens with their corresponding error information." }, { "info": { "name": "Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:reject", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/topics/:topicName/eventsubscriptions/:eventSubscriptionName:reject", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "topicName", "value": "", "type": "path", "description": "Topic Name." }, { "name": "eventSubscriptionName", "value": "", "type": "path", "description": "Event Subscription Name." } ] }, "docs": "Reject batch of Cloud Events. The server responds with an HTTP 200 status code if the request is successfully accepted. The response body will include the set of successfully rejected lockTokens, along with other failed lockTokens with their corresponding error information." }, { "info": { "name": "Microsoft Azure Post Topics Topicname Eventsubscriptions Eventsubscriptionname:renewlock", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/topics/:topicName/eventsubscriptions/:eventSubscriptionName:renewLock", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "topicName", "value": "", "type": "path", "description": "Topic Name." }, { "name": "eventSubscriptionName", "value": "", "type": "path", "description": "Event Subscription Name." } ] }, "docs": "Renew lock for batch of Cloud Events. The server responds with an HTTP 200 status code if the request is successfully accepted. The response body will include the set of successfully renewed lockTokens, along with other failed lockTokens with their corresponding error information." }, { "info": { "name": "Microsoft Azure Get A Topic", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/topics/:topicName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "topicName", "value": "", "type": "path", "description": "Name of the topic." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "Get properties of a topic." }, { "info": { "name": "Microsoft Azure Create A Topic", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/topics/:topicName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "topicName", "value": "", "type": "path", "description": "Name of the topic." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "Asynchronously creates a new topic with the specified parameters." }, { "info": { "name": "Microsoft Azure Update A Topic", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/topics/:topicName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "topicName", "value": "", "type": "path", "description": "Name of the topic." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "Asynchronously updates a topic with the specified parameters." }, { "info": { "name": "Microsoft Azure Delete A Topic", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/topics/:topicName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "topicName", "value": "", "type": "path", "description": "Name of the topic." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "Delete existing topic." }, { "info": { "name": "Microsoft Azure List Topics Under An Azure Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.EventGrid/topics", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." }, { "name": "$filter", "value": "", "type": "query", "description": "The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'." }, { "name": "$top", "value": "", "type": "query", "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." } ] }, "docs": "List all the topics under an Azure subscription." }, { "info": { "name": "Microsoft Azure List Topics Under A Resource Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/topics", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." }, { "name": "$filter", "value": "", "type": "query", "description": "The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'." }, { "name": "$top", "value": "", "type": "query", "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." } ] }, "docs": "List all the topics under a resource group." }, { "info": { "name": "Microsoft Azure List Keys For A Topic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/topics/:topicName/listKeys", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "topicName", "value": "", "type": "path", "description": "Name of the topic." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "List the two keys used to publish to a topic." }, { "info": { "name": "Microsoft Azure Regenerate Key For A Topic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.EventGrid/topics/:topicName/regenerateKey", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "topicName", "value": "", "type": "path", "description": "Name of the topic." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "Regenerate a shared access key for a topic." }, { "info": { "name": "Microsoft Azure List Topic Event Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/:providerNamespace/:resourceTypeName/:resourceName/providers/Microsoft.EventGrid/eventTypes", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group within the user's subscription." }, { "name": "providerNamespace", "value": "", "type": "path", "description": "Namespace of the provider of the topic." }, { "name": "resourceTypeName", "value": "", "type": "path", "description": "Name of the topic type." }, { "name": "resourceName", "value": "", "type": "path", "description": "Name of the topic." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "List event types for a topic." }, { "info": { "name": "Microsoft Azure Get Properties Of An Extension Topic", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:scope/providers/Microsoft.EventGrid/extensionTopics/default", "params": [ { "name": "scope", "value": "", "type": "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." }, { "name": "api-version", "value": "", "type": "query", "description": "Version of the API to be used with the client request." } ] }, "docs": "Get the properties of an extension topic." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicebus Namespaces Namespacename Topics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServiceBus/namespaces/:namespaceName/topics" }, "docs": "Gets all the topics in a namespace." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicebus Namespaces Namespacename Topics Topicname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServiceBus/namespaces/:namespaceName/topics/:topicName" }, "docs": "Returns a description for the specified topic." }, { "info": { "name": "Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicebus Namespaces Namespacename Topics Topicname", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServiceBus/namespaces/:namespaceName/topics/:topicName" }, "docs": "Creates a topic in the specified namespace." }, { "info": { "name": "Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicebus Namespaces Namespacename Topics Topicname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServiceBus/namespaces/:namespaceName/topics/:topicName" }, "docs": "Deletes a topic from the specified namespace and resource group." } ] } ], "bundled": true }