Azure Native
getScheduledAction
Scheduled action definition. API Version: 2022-04-01-preview.
Using getScheduledAction
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getScheduledAction(args: GetScheduledActionArgs, opts?: InvokeOptions): Promise<GetScheduledActionResult>
function getScheduledActionOutput(args: GetScheduledActionOutputArgs, opts?: InvokeOptions): Output<GetScheduledActionResult>
def get_scheduled_action(name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetScheduledActionResult
def get_scheduled_action_output(name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetScheduledActionResult]
func LookupScheduledAction(ctx *Context, args *LookupScheduledActionArgs, opts ...InvokeOption) (*LookupScheduledActionResult, error)
func LookupScheduledActionOutput(ctx *Context, args *LookupScheduledActionOutputArgs, opts ...InvokeOption) LookupScheduledActionResultOutput
> Note: This function is named LookupScheduledAction
in the Go SDK.
public static class GetScheduledAction
{
public static Task<GetScheduledActionResult> InvokeAsync(GetScheduledActionArgs args, InvokeOptions? opts = null)
public static Output<GetScheduledActionResult> Invoke(GetScheduledActionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetScheduledActionResult> getScheduledAction(GetScheduledActionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: azure-native:costmanagement:getScheduledAction
Arguments:
# Arguments dictionary
The following arguments are supported:
- Name string
Scheduled action name.
- Name string
Scheduled action name.
- name String
Scheduled action name.
- name string
Scheduled action name.
- name str
Scheduled action name.
- name String
Scheduled action name.
getScheduledAction Result
The following output properties are available:
- Display
Name string Scheduled action name.
- ETag string
Resource Etag.
- Id string
Resource Id.
- Name string
Resource name.
- Notification
Pulumi.
Azure Native. Cost Management. Outputs. Notification Properties Response Notification properties based on scheduled action kind.
- Schedule
Pulumi.
Azure Native. Cost Management. Outputs. Schedule Properties Response Schedule of the scheduled action.
- Status string
Status of the scheduled action.
- System
Data Pulumi.Azure Native. Cost Management. Outputs. System Data Response Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
Resource type.
- View
Id string Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'
- File
Destination Pulumi.Azure Native. Cost Management. Outputs. File Destination Response Destination format of the view data.
- Kind string
Kind of the scheduled action.
- Scope string
Cost Management scope like '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 ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
- Display
Name string Scheduled action name.
- ETag string
Resource Etag.
- Id string
Resource Id.
- Name string
Resource name.
- Notification
Notification
Properties Response Notification properties based on scheduled action kind.
- Schedule
Schedule
Properties Response Schedule of the scheduled action.
- Status string
Status of the scheduled action.
- System
Data SystemData Response Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
Resource type.
- View
Id string Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'
- File
Destination FileDestination Response Destination format of the view data.
- Kind string
Kind of the scheduled action.
- Scope string
Cost Management scope like '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 ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
- display
Name String Scheduled action name.
- e
Tag String Resource Etag.
- id String
Resource Id.
- name String
Resource name.
- notification
Notification
Properties Response Notification properties based on scheduled action kind.
- schedule
Schedule
Properties Response Schedule of the scheduled action.
- status String
Status of the scheduled action.
- system
Data SystemData Response Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
Resource type.
- view
Id String Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'
- file
Destination FileDestination Response Destination format of the view data.
- kind String
Kind of the scheduled action.
- scope String
Cost Management scope like '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 ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
- display
Name string Scheduled action name.
- e
Tag string Resource Etag.
- id string
Resource Id.
- name string
Resource name.
- notification
Notification
Properties Response Notification properties based on scheduled action kind.
- schedule
Schedule
Properties Response Schedule of the scheduled action.
- status string
Status of the scheduled action.
- system
Data SystemData Response Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
Resource type.
- view
Id string Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'
- file
Destination FileDestination Response Destination format of the view data.
- kind string
Kind of the scheduled action.
- scope string
Cost Management scope like '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 ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
- display_
name str Scheduled action name.
- e_
tag str Resource Etag.
- id str
Resource Id.
- name str
Resource name.
- notification
Notification
Properties Response Notification properties based on scheduled action kind.
- schedule
Schedule
Properties Response Schedule of the scheduled action.
- status str
Status of the scheduled action.
- system_
data SystemData Response Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
Resource type.
- view_
id str Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'
- file_
destination FileDestination Response Destination format of the view data.
- kind str
Kind of the scheduled action.
- scope str
Cost Management scope like '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 ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
- display
Name String Scheduled action name.
- e
Tag String Resource Etag.
- id String
Resource Id.
- name String
Resource name.
- notification Property Map
Notification properties based on scheduled action kind.
- schedule Property Map
Schedule of the scheduled action.
- status String
Status of the scheduled action.
- system
Data Property Map Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
Resource type.
- view
Id String Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'
- file
Destination Property Map Destination format of the view data.
- kind String
Kind of the scheduled action.
- scope String
Cost Management scope like '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 ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
Supporting Types
FileDestinationResponse
- File
Formats List<string> Destination of the view data. Currently only csv format is supported.
- File
Formats []string Destination of the view data. Currently only csv format is supported.
- file
Formats List<String> Destination of the view data. Currently only csv format is supported.
- file
Formats string[] Destination of the view data. Currently only csv format is supported.
- file_
formats Sequence[str] Destination of the view data. Currently only csv format is supported.
- file
Formats List<String> Destination of the view data. Currently only csv format is supported.
NotificationPropertiesResponse
SchedulePropertiesResponse
- End
Date string The end date and time of the scheduled action (UTC).
- Frequency string
Frequency of the schedule.
- Start
Date string The start date and time of the scheduled action (UTC).
- Day
Of intMonth UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
- Days
Of List<string>Week Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
- Hour
Of intDay UTC time at which cost analysis data will be emailed.
- Weeks
Of List<string>Month Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
- End
Date string The end date and time of the scheduled action (UTC).
- Frequency string
Frequency of the schedule.
- Start
Date string The start date and time of the scheduled action (UTC).
- Day
Of intMonth UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
- Days
Of []stringWeek Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
- Hour
Of intDay UTC time at which cost analysis data will be emailed.
- Weeks
Of []stringMonth Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
- end
Date String The end date and time of the scheduled action (UTC).
- frequency String
Frequency of the schedule.
- start
Date String The start date and time of the scheduled action (UTC).
- day
Of IntegerMonth UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
- days
Of List<String>Week Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
- hour
Of IntegerDay UTC time at which cost analysis data will be emailed.
- weeks
Of List<String>Month Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
- end
Date string The end date and time of the scheduled action (UTC).
- frequency string
Frequency of the schedule.
- start
Date string The start date and time of the scheduled action (UTC).
- day
Of numberMonth UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
- days
Of string[]Week Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
- hour
Of numberDay UTC time at which cost analysis data will be emailed.
- weeks
Of string[]Month Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
- end_
date str The end date and time of the scheduled action (UTC).
- frequency str
Frequency of the schedule.
- start_
date str The start date and time of the scheduled action (UTC).
- day_
of_ intmonth UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
- days_
of_ Sequence[str]week Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
- hour_
of_ intday UTC time at which cost analysis data will be emailed.
- weeks_
of_ Sequence[str]month Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
- end
Date String The end date and time of the scheduled action (UTC).
- frequency String
Frequency of the schedule.
- start
Date String The start date and time of the scheduled action (UTC).
- day
Of NumberMonth UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
- days
Of List<String>Week Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.
- hour
Of NumberDay UTC time at which cost analysis data will be emailed.
- weeks
Of List<String>Month Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.
SystemDataResponse
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- created
At string The timestamp of resource creation (UTC).
- created
By string The identity that created the resource.
- created
By stringType The type of identity that created the resource.
- last
Modified stringAt The timestamp of resource last modification (UTC)
- last
Modified stringBy The identity that last modified the resource.
- last
Modified stringBy Type The type of identity that last modified the resource.
- created_
at str The timestamp of resource creation (UTC).
- created_
by str The identity that created the resource.
- created_
by_ strtype The type of identity that created the resource.
- last_
modified_ strat The timestamp of resource last modification (UTC)
- last_
modified_ strby The identity that last modified the resource.
- last_
modified_ strby_ type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
Package Details
- Repository
- https://github.com/pulumi/pulumi-azure-native
- License
- Apache-2.0