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

Description

檢查保存庫名稱是否有效，且尚未使用中。

範例

範例 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

在執行 Cmdlet 之前，提示您進行確認。

類型:	SwitchParameter
別名:	cf
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DefaultProfile

DefaultProfile 參數無法運作。如果針對不同的訂用帳戶執行 Cmdlet，請使用 SubscriptionId 參數。

類型:	PSObject
別名:	AzureRMContext, AzureCredential
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-JsonFilePath

提供給檢查作業的 Json 檔案路徑

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-JsonString

提供給檢查作業的 Json 字串

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-Name

保存庫名稱。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-SubscriptionId

可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。

類型:	String
Position:	Named
預設值:	(Get-AzContext).Subscription.Id
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 Cmdlet 未執行。

類型:	SwitchParameter
別名:	wi
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

輸出

ICheckNameAvailabilityResult

共用方式為