Scheduled Actions - Get By Scope

Služba:: Cost Management

Verze rozhraní API:: 2025-03-01

Získejte sdílenou naplánovanou akci z daného oboru podle názvu.

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}?api-version=2025-03-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
name	path	True	string	Název naplánované akce
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.

Odpovědi

Name	Typ	Description
200 OK	ScheduledAction	OK. Požadavek byl úspěšný.
Other Status Codes	ErrorResponseWithNestedDetails	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

ScheduledActionByScope

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource?api-version=2025-03-01

Ukázková odpověď

Stavový kód:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource",
  "name": "monthlyCostByResource",
  "type": "Microsoft.CostManagement/ScheduledActions",
  "kind": "Email",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "systemData": {
    "createdBy": "testuser",
    "createdByType": "User",
    "createdAt": "2020-06-18T22:21:51.1287144Z",
    "lastModifiedBy": "testuser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-18T22:21:51.1287144Z"
  },
  "properties": {
    "displayName": "Monthly Cost By Resource",
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample",
    "schedule": {
      "frequency": "Monthly",
      "weeksOfMonth": [
        "First",
        "Third"
      ],
      "daysOfWeek": [
        "Monday"
      ],
      "hourOfDay": 10,
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "notification": {
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost by resource this month"
    }
  }
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
DaysOfWeek	Dny v týdnu.
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í.
FileDestination	Cíl dat zobrazení. Toto je volitelné. Aktuálně se podporuje jenom formát CSV.
FileFormat	Cíl dat zobrazení. Aktuálně se podporuje jenom formát CSV.
NotificationProperties	Vlastnosti oznámení naplánované akce.
ScheduledAction	Definice naplánované akce
ScheduledActionKind	Druh naplánované akce.
ScheduledActionStatus	Stav naplánované akce
ScheduleFrequency	Frekvence plánu.
ScheduleProperties	Vlastnosti plánu.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
WeeksOfMonth	Týdny měsíce.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DaysOfWeek

Výčet

Dny v týdnu.

Hodnota	Description
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

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ě.

FileDestination

Objekt

Cíl dat zobrazení. Toto je volitelné. Aktuálně se podporuje jenom formát CSV.

Name	Typ	Description
fileFormats	FileFormat[]	Cíl dat zobrazení. Aktuálně se podporuje jenom formát CSV.

FileFormat

Výčet

Cíl dat zobrazení. Aktuálně se podporuje jenom formát CSV.

Hodnota	Description
Csv

NotificationProperties

Objekt

Vlastnosti oznámení naplánované akce.

Name	Typ	Description
language	string	Národní prostředí e-mailu
message	string	Volitelná zpráva, která se má přidat do e-mailu Délka je omezená na 250 znaků.
regionalFormat	string	Místní formát používaný pro formátování hodnot data a času a měny v e-mailu.
subject	string	Předmět e-mailu Délka je omezená na 70 znaků.
to	string[] pattern: ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$	Pole e-mailových adres