Test-AzKeyVaultManagedHsmNameAvailability

モジュール:

Az.KeyVault

マネージド HSM 名が有効であり、まだ使用されていないことを確認します。

構文

Test-AzKeyVaultManagedHsmNameAvailability
    [-SubscriptionId <String>]
    -Name <String>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Test-AzKeyVaultManagedHsmNameAvailability
    [-SubscriptionId <String>]
    -JsonFilePath <String>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Test-AzKeyVaultManagedHsmNameAvailability
    [-SubscriptionId <String>]
    -JsonString <String>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

マネージド HSM 名が有効であり、まだ使用されていないことを確認します。

例

例 1: 未使用の HSM 名の可用性をテストする

Test-AzKeyVaultManagedHsmNameAvailability -Name testmhsm0818

Message NameAvailable Reason
------- ------------- ------
                 True

このコマンドは、コンテナー名 testmhsm0818の可用性をテストします。 結果は、 testmhsm0818 が占有されていないことを示しています。

例 2: 使用されている HSM 名の可用性をテストする

Test-AzKeyVaultNameAvailability -Name testmhsm

Message                               NameAvailable Reason
-------                               ------------- ------
The name 'testmhsm' is already in use.         False AlreadyExists

このコマンドは、HSM 名 testmhsmの可用性をテストします。 結果は、 testmhsm が既に使用されていることを示しています。

パラメーター

-Confirm

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

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

-DefaultProfile

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

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

-JsonFilePath

Check 操作に指定された Json ファイルのパス

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

-JsonString

Check 操作に指定された Json 文字列

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

-Name

マネージド HSM 名。

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

-SubscriptionId

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

出力

ICheckMhsmNameAvailabilityResult