Accounts - Check Name Availability

服務:

Azure Video Indexer

API 版本:

2024-01-01

檢查影片索引器帳戶名稱是否有效，且尚未使用中。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/checkNameAvailability?api-version=2024-01-01

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
name	True	string	VideoIndexer 帳戶名稱。
type	True	Type	資源類型，Microsoft.VideoIndexer/accounts

回應

名稱	類型	Description
200 OK	CheckNameAvailabilityResult	確定 -檢查影片索引器帳戶名稱可用性的作業已成功。 [確定] 不會指出名稱可用，回應的本文則為 。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Check free account name availability

Check taken account name availability

Check free account name availability

範例要求

HTTP

POST https://management.azure.com/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/providers/Microsoft.VideoIndexer/checkNameAvailability?api-version=2024-01-01

{
  "name": "vi1",
  "type": "Microsoft.VideoIndexer/accounts"
}

範例回覆

狀態碼:

200

{
  "nameAvailable": true
}

Check taken account name availability

範例要求

HTTP

POST https://management.azure.com/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/providers/Microsoft.VideoIndexer/checkNameAvailability?api-version=2024-01-01

{
  "name": "vi1",
  "type": "Microsoft.VideoIndexer/accounts"
}

範例回覆

狀態碼:

200

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "Resource name already exists"
}

定義

名稱	Description
AccountCheckNameAvailabilityParameters	用來檢查影片索引器帳戶名稱可用性的參數。
CheckNameAvailabilityResult	CheckNameAvailability 作業回應。
ErrorDefinition	錯誤定義。
ErrorResponse	錯誤回應。
Reason	取得無法使用影片索引器帳戶名稱的原因。 只有在 NameAvailable 為 false 時，才會傳回 Reason 元素。
Type	資源類型，Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

用來檢查影片索引器帳戶名稱可用性的參數。

名稱	類型	Description
name	string	VideoIndexer 帳戶名稱。
type	Type	資源類型，Microsoft.VideoIndexer/accounts

CheckNameAvailabilityResult

CheckNameAvailability 作業回應。

名稱	類型	Description
message	string	取得錯誤訊息，詳細說明 Reason 值。
nameAvailable	boolean	取得布爾值，指出名稱是否可供您使用。 如果為 true，則表示名稱可用。 如果為 false，表示已經取得名稱。
reason	Reason	取得無法使用影片索引器帳戶名稱的原因。 只有在 NameAvailable 為 false 時，才會傳回 Reason 元素。

ErrorDefinition

錯誤定義。

名稱	類型	Description
code	string	服務特定的錯誤碼，可作為 HTTP 錯誤碼的子狀態。
details	ErrorDefinition[]	內部錯誤詳細數據。
message	string	錯誤的描述。

ErrorResponse

錯誤回應。

名稱	類型	Description
error	ErrorDefinition	錯誤詳細資料。

Reason

取得無法使用影片索引器帳戶名稱的原因。 只有在 NameAvailable 為 false 時，才會傳回 Reason 元素。

名稱	類型	Description
AlreadyExists	string

Type

資源類型，Microsoft.VideoIndexer/accounts

名稱	類型	Description
Microsoft.VideoIndexer/accounts	string