New-AzCommunicationServiceKey

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

Syntax

New-AzCommunicationServiceKey
   -CommunicationServiceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-KeyType <KeyType>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzCommunicationServiceKey
   -CommunicationServiceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -Parameter <IRegenerateKeyParameters>
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzCommunicationServiceKey
   -InputObject <ICommunicationIdentity>
   [-KeyType <KeyType>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzCommunicationServiceKey
   -InputObject <ICommunicationIdentity>
   -Parameter <IRegenerateKeyParameters>
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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

Examples

Example 1: Regenerates the Primary key using a IRegenerateKeyParameters hashtable

New-AzCommunicationServiceKey -CommunicationServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -Parameter @{KeyType="Primary"}

PrimaryConnectionString              PrimaryKey
-----------------------              ----------
endpoint=<example-primary-endpoint>  <example-primarykey>

Invalidates the previous Primary key, regenerate a new one and return it.

Example 2: Regenerates the Secondary key using a KeyType

New-AzCommunicationServiceKey -CommunicationServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -KeyType Secondary

SecondaryConnectionString               SecondaryKey
-----------------------                 ----------
endpoint=<example-secondary-endpoint>   <example-secondarykey>

Invalidates the previous Secondary key, regenerate a new one and return it.

Parameters

-CommunicationServiceName

The name of the CommunicationService resource.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:ICommunicationIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-KeyType

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

Type:KeyType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Parameter

Parameters describes the request to regenerate access keys To construct, see NOTES section for PARAMETER properties and create a hash table.

Type:IRegenerateKeyParameters
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

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

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IRegenerateKeyParameters

ICommunicationIdentity

Outputs

ICommunicationServiceKeys