Managed Hsms - Check Mhsm Name Availability
檢查Managed hsm名稱是否有效,且尚未使用中。
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkMhsmNameAvailability?api-version=2022-07-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
要求本文
名稱 | 必要 | 類型 | Description |
---|---|---|---|
name | True |
string |
Managed hsm 名稱。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 -- 檢查 mhsm 名稱可用性的作業成功。 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
Validate a managed hsm name
範例要求
範例回覆
{
"nameAvailable": true
}
定義
名稱 | Description |
---|---|
Check |
用來檢查 Managed hsm 名稱可用性的參數。 |
Check |
CheckIlasmNameAvailability 作業回應。 |
Cloud |
來自 金鑰保存庫 資源提供者的錯誤回應 |
Cloud |
來自 金鑰保存庫 資源提供者的錯誤回應 |
Reason |
無法使用 Managed hsm 名稱的原因。 只有在 NameAvailable 為 false 時,才會傳回 reason 元素。 |
CheckMhsmNameAvailabilityParameters
用來檢查 Managed hsm 名稱可用性的參數。
名稱 | 類型 | Description |
---|---|---|
name |
string |
Managed hsm 名稱。 |
CheckMhsmNameAvailabilityResult
CheckIlasmNameAvailability 作業回應。
名稱 | 類型 | Description |
---|---|---|
message |
string |
詳細說明 Reason 值的錯誤訊息。 |
nameAvailable |
boolean |
布爾值,指出名稱是否可供您使用。 如果為 true,則表示名稱可用。 如果為 false,表示名稱已取得或無效,而且無法使用。 |
reason |
無法使用 Managed hsm 名稱的原因。 只有在 NameAvailable 為 false 時,才會傳回 reason 元素。 |
CloudError
來自 金鑰保存庫 資源提供者的錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
來自 金鑰保存庫 資源提供者的錯誤回應 |
CloudErrorBody
來自 金鑰保存庫 資源提供者的錯誤回應
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 這是可透過程序設計方式取用的助記鍵。 |
message |
string |
使用者易記的錯誤訊息。 訊息通常會當地語系化,而且可能會隨服務版本而有所不同。 |
Reason
無法使用 Managed hsm 名稱的原因。 只有在 NameAvailable 為 false 時,才會傳回 reason 元素。
名稱 | 類型 | Description |
---|---|---|
AccountNameInvalid |
string |
|
AlreadyExists |
string |