Namespaces - Regenerate Keys

Regenerates the primary or secondary connection strings for the namespace.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys?api-version=2017-04-01

URI Parameters

Name In Required Type Description
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.

resourceGroupName
path True
  • string

Name of the Resource group within the Azure subscription.

namespaceName
path True
  • string

The namespace name

authorizationRuleName
path True
  • string

The authorization rule name.

api-version
query True
  • string

Client API version.

Request Body

Name Required Type Description
key
  • string

Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType

keyType True

The access key to regenerate.

Responses

Name Type Description
200 OK

Authorization rule successfully regenerated.

Other Status Codes

ServiceBus 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

NameSpaceAuthorizationRuleRegenerateKey

Sample Request

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-namespace-6914/AuthorizationRules/sdk-AuthRules-1788/regenerateKeys?api-version=2017-04-01
{
  "keyType": "PrimaryKey"
}

Sample Response

{
  "primaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=#############################################",
  "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=#############################################",
  "primaryKey": "#############################################",
  "secondaryKey": "#############################################",
  "keyName": "sdk-AuthRules-1788"
}

Definitions

AccessKeys

Namespace/ServiceBus Connection String

ErrorResponse

Error response indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.

KeyType

The access key to regenerate.

RegenerateAccessKeyParameters

Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset.

AccessKeys

Namespace/ServiceBus Connection String

Name Type Description
aliasPrimaryConnectionString
  • string

Primary connection string of the alias if GEO DR is enabled

aliasSecondaryConnectionString
  • string

Secondary connection string of the alias if GEO DR is enabled

keyName
  • string

A string that describes the authorization rule.

primaryConnectionString
  • string

Primary connection string of the created namespace authorization rule.

primaryKey
  • string

A base64-encoded 256-bit primary key for signing and validating the SAS token.

secondaryConnectionString
  • string

Secondary connection string of the created namespace authorization rule.

secondaryKey
  • string

A base64-encoded 256-bit primary key for signing and validating the SAS token.

ErrorResponse

Error response indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.

Name Type Description
code
  • string

Error code.

message
  • string

Error message indicating why the operation failed.

KeyType

The access key to regenerate.

Name Type Description
PrimaryKey
  • string
SecondaryKey
  • string

RegenerateAccessKeyParameters

Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset.

Name Type Description
key
  • string

Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType

keyType

The access key to regenerate.