Scheduled Actions - Get By Scope

Referentie

Service:: Cost Management

API-versie:: 2024-08-01

Haal de gedeelde geplande actie op basis van de naam van het opgegeven bereik op.

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

URI-parameters

Name	In	Vereist	Type	Description
name	path	True	string	Naam van geplande actie.
scope	path	True	string	Het bereik dat is gekoppeld aan geplande actiebewerkingen. Dit omvat abonnementen/{subscriptionId} voor abonnementsbereik, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' voor resourceGroup-bereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' voor het bereik van de factureringsrekening, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/afdelingen/{departmentId}' voor afdelingsbereik, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} voor het bereik EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' voor het bereik BillingProfile, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' voor het bereik InvoiceSection, providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName} voor het bereik externe factureringsaccount en providers/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName} voor extern abonnementsbereik. Opmerking: Inzichtwaarschuwingen zijn alleen beschikbaar voor abonnementsbereik.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	ScheduledAction	OK. De aanvraag is voltooid.
Other Status Codes	ErrorResponseWithNestedDetails	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ScheduledActionByScope

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
DaysOfWeek	Dagen van de week.
ErrorDetailsWithNestedDetails	De details van de fout.
ErrorResponseWithNestedDetails	Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht. Enkele foutberichten: 429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.
FileDestination	Doel van de weergavegegevens. Dit is optioneel. Momenteel wordt alleen csv-indeling ondersteund.
FileFormat	Doel van de weergavegegevens. Momenteel wordt alleen csv-indeling ondersteund.
NotificationProperties	De eigenschappen van de geplande actiemelding.
ScheduledAction	Geplande actiedefinitie.
ScheduledActionKind	Soort van de geplande actie.
ScheduledActionStatus	Status van de geplande actie.
ScheduleFrequency	Frequentie van de planning.
ScheduleProperties	De eigenschappen van de planning.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
WeeksOfMonth	Weken van de maand.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DaysOfWeek

Dagen van de week.

Name	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorDetailsWithNestedDetails

De details van de fout.

Name	Type	Description
code	string	Foutcode.
details	ErrorDetailsWithNestedDetails[]	De aanvullende details van de fout.
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

ErrorResponseWithNestedDetails

Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht.

Enkele foutberichten:

429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.

Name	Type	Description
error	ErrorDetailsWithNestedDetails	De details van de fout.

FileDestination

Doel van de weergavegegevens. Dit is optioneel. Momenteel wordt alleen csv-indeling ondersteund.

Name	Type	Description
fileFormats	FileFormat[]	Doel van de weergavegegevens. Momenteel wordt alleen csv-indeling ondersteund.

FileFormat

Doel van de weergavegegevens. Momenteel wordt alleen csv-indeling ondersteund.

Name	Type	Description
Csv	string

NotificationProperties

De eigenschappen van de geplande actiemelding.

Name	Type	Description
language	string	Landinstelling van het e-mailbericht.
message	string	Optioneel bericht dat in het e-mailbericht moet worden toegevoegd. De lengte is beperkt tot 250 tekens.
regionalFormat	string	Regionale indeling die wordt gebruikt voor het opmaken van datum/tijd en valutawaarden in het e-mailbericht.
subject	string	Onderwerp van het e-mailbericht. De lengte is beperkt tot 70 tekens.
to	string[]	Matrix met e-mailadressen.