Scheduled Actions - Check Name Availability By Scope

Dienst:

Cost Management

API-Version:

2024-08-01

Überprüft die Verfügbarkeit und Richtigkeit des Namens für eine geplante Aktion innerhalb des angegebenen Bereichs.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
scope	path	True	string	Der Bereich, der geplanten Aktionsvorgängen zugeordnet ist. Dies umfasst "abonnements/{subscriptionId}" für den Abonnementbereich, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für resourceGroup-Bereich, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' für Abteilungsbereich, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' für enrollmentAccount-Bereich, '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}' für den Bereich externes Abonnement. Hinweis: Insight Alerts sind nur im Abonnementbereich verfügbar.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
name	string	Der Name der Ressource, für die die Verfügbarkeit überprüft werden muss.
type	string	Der Ressourcentyp.

Antworten

Name	Typ	Beschreibung
200 OK	CheckNameAvailabilityResponse	Antwort auf die Verfügbarkeit des geplanten Aktionsnamens.
Other Status Codes	ErrorResponseWithNestedDetails	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ScheduledActionCheckNameAvailabilityByScope

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

{
  "nameAvailable": true
}

Definitionen

Name	Beschreibung
CheckNameAvailabilityReason	Der Grund, warum der angegebene Name nicht verfügbar ist.
CheckNameAvailabilityRequest	Der Anforderungstext der Überprüfung.
CheckNameAvailabilityResponse	Das Verfügbarkeitsergebnis der Überprüfung.
ErrorDetailsWithNestedDetails	Die Details des Fehlers.
ErrorResponseWithNestedDetails	Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. Einige Fehlerantworten: 429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit. 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.

CheckNameAvailabilityReason

Enumeration

Der Grund, warum der angegebene Name nicht verfügbar ist.

Wert	Beschreibung
AlreadyExists
Invalid

CheckNameAvailabilityRequest

Objekt

Der Anforderungstext der Überprüfung.

Name	Typ	Beschreibung
name	string	Der Name der Ressource, für die die Verfügbarkeit überprüft werden muss.
type	string	Der Ressourcentyp.

CheckNameAvailabilityResponse

Objekt

Das Verfügbarkeitsergebnis der Überprüfung.

Name	Typ	Beschreibung
message	string	Detaillierter Grund, warum der angegebene Name verfügbar ist.
nameAvailable	boolean	Gibt an, ob der Ressourcenname verfügbar ist.
reason	CheckNameAvailabilityReason	Der Grund, warum der angegebene Name nicht verfügbar ist.

ErrorDetailsWithNestedDetails

Objekt

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode.
details	ErrorDetailsWithNestedDetails[]	Die zusätzlichen Details des Fehlers.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponseWithNestedDetails

Objekt

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Einige Fehlerantworten:

• 429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit.

• 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.

Name	Typ	Beschreibung
error	ErrorDetailsWithNestedDetails	Die Details des Fehlers.