Scheduled Actions - Check Name Availability By Scope

Reference

Service:: Cost Management

API Version:: 2024-08-01

Checks availability and correctness of the name for a scheduled action within the given scope.

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

URI Parameters

Name	In	Required	Type	Description
scope	path	True	string	The scope associated with scheduled action operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, '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. Note: Insight Alerts are only available on subscription scope.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
name	string	The name of the resource for which availability needs to be checked.
type	string	The resource type.

Responses

Name	Type	Description
200 OK	CheckNameAvailabilityResponse	Response of scheduled action name availability.
Other Status Codes	ErrorResponseWithNestedDetails	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ScheduledActionCheckNameAvailabilityByScope

Sample request

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"
}

Sample response

Status code:: 200

{
  "nameAvailable": true
}

Definitions

Name	Description
CheckNameAvailabilityReason	The reason why the given name is not available.
CheckNameAvailabilityRequest	The check availability request body.
CheckNameAvailabilityResponse	The check availability result.
ErrorDetailsWithNestedDetails	The details of the error.
ErrorResponseWithNestedDetails	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. Some Error responses: 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header. 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

CheckNameAvailabilityReason

The reason why the given name is not available.

Name	Type	Description
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

The check availability request body.

Name	Type	Description
name	string	The name of the resource for which availability needs to be checked.
type	string	The resource type.

CheckNameAvailabilityResponse

The check availability result.

Name	Type	Description
message	string	Detailed reason why the given name is available.
nameAvailable	boolean	Indicates if the resource name is available.
reason	CheckNameAvailabilityReason	The reason why the given name is not available.

ErrorDetailsWithNestedDetails

The details of the error.

Name	Type	Description
code	string	Error code.
details	ErrorDetailsWithNestedDetails[]	The additional details of the error.
message	string	Error message indicating why the operation failed.

ErrorResponseWithNestedDetails

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Some Error responses:

429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header.
503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

Name	Type	Description
error	ErrorDetailsWithNestedDetails	The details of the error.

Partager via