AZazure
CommunicationServices

Regenerate Key

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

post/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/regenerateKey

Request

  • Base URL
    https://management.azure.com
  • URL
    https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/regenerateKey
  • Auth
    OAuth 2
    Implicit: https://login.microsoftonline.com/common/oauth2/authorize
    Scopes: user_impersonation

Path parameters

communicationServiceNamestring required

The name of the CommunicationService resource.

Parameters

../../../../../common-types/resource-management/v6/types.json#/components/parameters/ApiVersionParameter (unresolved $ref)
../../../../../common-types/resource-management/v6/types.json#/components/parameters/SubscriptionIdParameter (unresolved $ref)
../../../../../common-types/resource-management/v6/types.json#/components/parameters/ResourceGroupNameParameter (unresolved $ref)

Request body

keyType'Primary' | 'Secondary'

The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).

Response

Azure operation completed successfully.

primaryKeystring

The primary access key.

secondaryKeystring

The secondary access key.

primaryConnectionStringstring

CommunicationService connection string constructed via the primaryKey

secondaryConnectionStringstring

CommunicationService connection string constructed via the secondaryKey

Changes

No recorded changes to this operation across all 1 revision of this API.