New-AzCommunicationServiceKey

モジュール:

Az.Communication

CommunicationService アクセス キーを再生成します。 PrimaryKey と SecondaryKey を同時に再生成することはできません。

構文

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>]

説明

CommunicationService アクセス キーを再生成します。 PrimaryKey と SecondaryKey を同時に再生成することはできません。

例

例 1: IRegenerateKeyParameters ハッシュテーブルを使用して主キーを再生成する

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

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

前の主キーを無効にし、新しいキーを再生成して返します。

例 2: KeyType を使用してセカンダリ キーを再生成する

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

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

前のセカンダリ キーを無効にし、新しいセカンダリ キーを再生成して返します。

パラメーター

-CommunicationServiceName

CommunicationService リソースの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

型:	PSObject
Aliases:	AzureRMContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

ID パラメーターを構築するには、INPUTOBJECT プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

型:	ICommunicationIdentity
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-KeyType

再生成する keyType。 'primary' または 'secondary' (大文字と小文字は区別されません) である必要があります。

型:	KeyType
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Parameter

パラメーターは、構築するアクセス キーを再生成する要求を記述します。PARAMETER プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

型:	IRegenerateKeyParameters
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソース グループの名前。 名前では大文字と小文字が区別されません。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SubscriptionId

ターゲット サブスクリプションの ID。 値は UUID である必要があります。

型:	String
配置:	Named
規定値:	(Get-AzContext).Subscription.Id
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

IRegenerateKeyParameters

ICommunicationIdentity

出力

ICommunicationServiceKeys