Partner Namespaces - Regenerate Key

Service:

Event Grid

API Version:

2025-02-15

Regenerate key for a partner namespace.
Regenerate a shared access key for a partner namespace.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/regenerateKey?api-version=2025-02-15

URI Parameters

Name	In	Required	Type	Description
partnerNamespaceName	path	True	string	Name of the partner namespace.
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.
api-version	query	True	string	Version of the API to be used with the client request.

Request Body

Name	Required	Type	Description
keyName	True	string	Key name to regenerate (key1 or key2).

Responses

Name	Type	Description
200 OK	PartnerNamespaceSharedAccessKeys	OK
Other Status Codes	ErrorResponse	Error response returned if request was unsuccessful.

Examples

PartnerNamespaces_RegenerateKey

Sample request

HTTP

POST https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1/regenerateKey?api-version=2025-02-15

{
  "keyName": "key1"
}

Sample response

Status code:

200

{
  "key1": "testKey1Value",
  "key2": "testKey2Value"
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
PartnerNamespaceRegenerateKeyRequest	PartnerNamespace regenerate shared access key request.
PartnerNamespaceSharedAccessKeys	Shared access keys of the partner namespace.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

PartnerNamespaceRegenerateKeyRequest

Object

PartnerNamespace regenerate shared access key request.

Name	Type	Description
keyName	string	Key name to regenerate (key1 or key2).

PartnerNamespaceSharedAccessKeys

Object

Shared access keys of the partner namespace.

Name	Type	Description
key1	string	Shared access key1 for the partner namespace.
key2	string	Shared access key2 for the partner namespace.