Scheduled Actions - Check Name Availability By Scope

リファレンス

サービス:: Cost Management

API バージョン:: 2024-08-01

指定されたスコープ内のスケジュールされたアクションの名前の可用性と正確性を確認します。

POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/checkNameAvailability?api-version=2024-08-01

URI パラメーター

名前	/	必須	型	説明
scope	path	True	string	スケジュールされたアクション操作に関連付けられているスコープ。これには、サブスクリプションスコープの 'subscriptions/{subscriptionId}' が含まれます。 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccount スコープの enrollmentAccountId}'、BillingProfile スコープの場合は 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. 注: Insight アラートは、サブスクリプションスコープでのみ使用できます。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
name	string	可用性を確認する必要があるリソースの名前。
type	string	リソースの種類。

応答

名前	型	説明
200 OK	CheckNameAvailabilityResponse	スケジュールされたアクション名の可用性の応答。
Other Status Codes	ErrorResponseWithNestedDetails	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

ScheduledActionCheckNameAvailabilityByScope

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/checkNameAvailability?api-version=2024-08-01

{
  "name": "testName",
  "type": "Microsoft.CostManagement/ScheduledActions"
}

応答のサンプル

状態コード:: 200

{
  "nameAvailable": true
}

定義

名前	説明
CheckNameAvailabilityReason	指定された名前が使用できない理由。
CheckNameAvailabilityRequest	可用性確認要求本文。
CheckNameAvailabilityResponse	可用性チェックの結果。
ErrorDetailsWithNestedDetails	エラーの詳細。
ErrorResponseWithNestedDetails	エラー応答は、サービスが受信要求を処理できないことを示します。エラーメッセージに理由が示されます。いくつかのエラー応答: 429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時刻を待機した後に再試行します。 503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻を待機した後に再試行します。

CheckNameAvailabilityReason

指定された名前が使用できない理由。

名前	型	説明
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

可用性確認要求本文。

名前	型	説明
name	string	可用性を確認する必要があるリソースの名前。
type	string	リソースの種類。

CheckNameAvailabilityResponse

可用性チェックの結果。

名前	型	説明
message	string	指定された名前を使用できる詳細な理由。
nameAvailable	boolean	リソース名が使用可能かどうかを示します。
reason	CheckNameAvailabilityReason	指定された名前が使用できない理由。

ErrorDetailsWithNestedDetails

エラーの詳細。

名前	型	説明
code	string	エラーコード。
details	ErrorDetailsWithNestedDetails[]	エラーの追加の詳細。
message	string	操作が失敗した理由を示すエラーメッセージ。

ErrorResponseWithNestedDetails

エラー応答は、サービスが受信要求を処理できないことを示します。エラーメッセージに理由が示されます。

いくつかのエラー応答:

429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時刻を待機した後に再試行します。
503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻を待機した後に再試行します。

名前	型	説明
error	ErrorDetailsWithNestedDetails	エラーの詳細。

次の方法で共有