Test-AzKeyVaultNameAvailability

モジュール:

Az.KeyVault

コンテナー名が有効であり、まだ使用されていないことを確認します。

構文

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

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

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

説明

コンテナー名が有効であり、まだ使用されていないことを確認します。

例

例 1: 未使用のコンテナー名の可用性をテストする

Test-AzKeyVaultNameAvailability -Name test-kv0818

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

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

例 2: 使用されているコンテナー名の可用性をテストする

Test-AzKeyVaultNameAvailability -Name testkv

Message
-------                                                                                                                                                                      
The vault name 'testkv' is already in use. Vault names are globally unique so it is possible that the name is already taken. If you are sure that the vault name was not …

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

パラメーター

-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

コンテナー名。

型:	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

出力

ICheckNameAvailabilityResult