Web Pub Sub - Regenerate Key

Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/regenerateKey?api-version=2024-03-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

resourceName
path True

string

The name of the resource.

Regex pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$

subscriptionId
path True

string

uuid

The ID of the target subscription. The value must be an UUID.

api-version
query True

string

The API version to use for this operation.

Request Body

Name Type Description
keyType

KeyType

The type of access key.

Responses

Name Type Description
200 OK

WebPubSubKeys

Success

202 Accepted

WebPubSubKeys

Accepted and an async operation is executing in background to make the new key to take effect. The response contains new access keys and a Location header to query the async operation result.

Headers

Location: string

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

WebPubSub_RegenerateKey

Sample request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/webPubSub/myWebPubSubService/regenerateKey?api-version=2024-03-01

{
  "keyType": "Primary"
}

Sample response

{}
Location: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus...
{}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

KeyType

The type of access key.

RegenerateKeyParameters

Parameters describes the request to regenerate access keys

WebPubSubKeys

A class represents the access keys of the resource.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

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

Error response

Name Type Description
error

ErrorDetail

The error object.

KeyType

The type of access key.

Name Type Description
Primary

string

Salt

string

Secondary

string

RegenerateKeyParameters

Parameters describes the request to regenerate access keys

Name Type Description
keyType

KeyType

The type of access key.

WebPubSubKeys

A class represents the access keys of the resource.

Name Type Description
primaryConnectionString

string

Connection string constructed via the primaryKey

primaryKey

string

The primary access key.

secondaryConnectionString

string

Connection string constructed via the secondaryKey

secondaryKey

string

The secondary access key.