Scheduled Actions - Check Name Availability By Scope

Služba:

Cost Management

Verze rozhraní API:

2024-08-01

Kontroluje dostupnost a správnost názvu naplánované akce v daném oboru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
scope	path	True	string	Obor přidružený k plánovaným operacím akcí. To zahrnuje předplatná/{subscriptionId} pro rozsah předplatného. Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} pro obor resourceGroup, providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId} pro rozsah fakturačního účtu, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId} pro obor oddělení, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} pro obor EnrollmentAccount, Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} pro rozsah BillingProfile, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' pro rozsah InvoiceSection, providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName} pro rozsah externího fakturačního účtu a poskytovatele/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName} pro rozsah externího předplatného. Poznámka: Výstrahy přehledu jsou k dispozici pouze v rozsahu předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
name	string	Název prostředku, pro který je potřeba zkontrolovat dostupnost.
type	string	Typ prostředku.

Odpovědi

Name	Typ	Description
200 OK	CheckNameAvailabilityResponse	Odpověď na dostupnost názvu naplánované akce
Other Status Codes	ErrorResponseWithNestedDetails	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ScheduledActionCheckNameAvailabilityByScope

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

{
  "nameAvailable": true
}

Definice

Name	Description
CheckNameAvailabilityReason	Důvod, proč daný název není k dispozici.
CheckNameAvailabilityRequest	Text žádosti o dostupnost kontroly.
CheckNameAvailabilityResponse	Výsledek kontroly dostupnosti.
ErrorDetailsWithNestedDetails	Podrobnosti o chybě.
ErrorResponseWithNestedDetails	Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě. Některé chybové odpovědi: 429 TooManyRequests – Požadavek je omezený. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.

CheckNameAvailabilityReason

Výčet

Důvod, proč daný název není k dispozici.

Hodnota	Description
AlreadyExists
Invalid

CheckNameAvailabilityRequest

Objekt

Text žádosti o dostupnost kontroly.

Name	Typ	Description
name	string	Název prostředku, pro který je potřeba zkontrolovat dostupnost.
type	string	Typ prostředku.

CheckNameAvailabilityResponse

Objekt

Výsledek kontroly dostupnosti.

Name	Typ	Description
message	string	Podrobný důvod, proč je daný název dostupný
nameAvailable	boolean	Označuje, jestli je název prostředku dostupný.
reason	CheckNameAvailabilityReason	Důvod, proč daný název není k dispozici.

ErrorDetailsWithNestedDetails

Objekt

Podrobnosti o chybě.

Name	Typ	Description
code	string	Kód chyby
details	ErrorDetailsWithNestedDetails[]	Další podrobnosti o chybě.
message	string	Chybová zpráva označující, proč operace selhala.

ErrorResponseWithNestedDetails

Objekt

Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.

Některé chybové odpovědi:

• 429 TooManyRequests – Požadavek je omezený. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.

• 503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.

Name	Typ	Description
error	ErrorDetailsWithNestedDetails	Podrobnosti o chybě.