Topics - List Shared Access Keys

List keys for a topic.
List the two keys used to publish to a topic.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/listKeys?api-version=2022-06-15

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group within the user's subscription.

subscriptionId
path True

string

Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

topicName
path True

string

Name of the topic.

api-version
query True

string

Version of the API to be used with the client request.

Responses

Name Type Description
200 OK

TopicSharedAccessKeys

OK

Other Status Codes

*** Error Responses: ***

  • 400 Bad Request.

  • 500 Internal Server Error.

Examples

Topics_ListSharedAccessKeys

Sample Request

POST https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/listKeys?api-version=2022-06-15

Sample Response

{
  "key1": "<key1>",
  "key2": "<key2>"
}

Definitions

TopicSharedAccessKeys

Shared access keys of the Topic

Name Type Description
key1

string

Shared access key1 for the topic.

key2

string

Shared access key2 for the topic.