Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

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:

DisplayName string

Scheduled action name.

ETag string

Resource Etag.

Id string

Resource Id.

Name string

Resource name.

Notification Pulumi.AzureNative.CostManagement.Outputs.NotificationPropertiesResponse

Notification properties based on scheduled action kind.

Schedule Pulumi.AzureNative.CostManagement.Outputs.SchedulePropertiesResponse

Schedule of the scheduled action.

Status string

Status of the scheduled action.

SystemData Pulumi.AzureNative.CostManagement.Outputs.SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Type string

Resource type.

ViewId string

Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'

FileDestination Pulumi.AzureNative.CostManagement.Outputs.FileDestinationResponse

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.

DisplayName string

Scheduled action name.

ETag string

Resource Etag.

Id string

Resource Id.

Name string

Resource name.

Notification NotificationPropertiesResponse

Notification properties based on scheduled action kind.

Schedule SchedulePropertiesResponse

Schedule of the scheduled action.

Status string

Status of the scheduled action.

SystemData SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Type string

Resource type.

ViewId string

Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'

FileDestination FileDestinationResponse

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.

displayName String

Scheduled action name.

eTag String

Resource Etag.

id String

Resource Id.

name String

Resource name.

notification NotificationPropertiesResponse

Notification properties based on scheduled action kind.

schedule SchedulePropertiesResponse

Schedule of the scheduled action.

status String

Status of the scheduled action.

systemData SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type String

Resource type.

viewId String

Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'

fileDestination FileDestinationResponse

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.

displayName string

Scheduled action name.

eTag string

Resource Etag.

id string

Resource Id.

name string

Resource name.

notification NotificationPropertiesResponse

Notification properties based on scheduled action kind.

schedule SchedulePropertiesResponse

Schedule of the scheduled action.

status string

Status of the scheduled action.

systemData SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type string

Resource type.

viewId string

Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'

fileDestination FileDestinationResponse

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 NotificationPropertiesResponse

Notification properties based on scheduled action kind.

schedule SchedulePropertiesResponse

Schedule of the scheduled action.

status str

Status of the scheduled action.

system_data SystemDataResponse

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 FileDestinationResponse

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.

displayName String

Scheduled action name.

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

systemData Property Map

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type String

Resource type.

viewId String

Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'

fileDestination 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

FileFormats List<string>

Destination of the view data. Currently only csv format is supported.

FileFormats []string

Destination of the view data. Currently only csv format is supported.

fileFormats List<String>

Destination of the view data. Currently only csv format is supported.

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

fileFormats List<String>

Destination of the view data. Currently only csv format is supported.

NotificationPropertiesResponse

Subject string

Subject of the email. Length is limited to 70 characters.

To List<string>

Array of email addresses.

Message string

Optional message to be added in the email. Length is limited to 250 characters.

Subject string

Subject of the email. Length is limited to 70 characters.

To []string

Array of email addresses.

Message string

Optional message to be added in the email. Length is limited to 250 characters.

subject String

Subject of the email. Length is limited to 70 characters.

to List<String>

Array of email addresses.

message String

Optional message to be added in the email. Length is limited to 250 characters.

subject string

Subject of the email. Length is limited to 70 characters.

to string[]

Array of email addresses.

message string

Optional message to be added in the email. Length is limited to 250 characters.

subject str

Subject of the email. Length is limited to 70 characters.

to Sequence[str]

Array of email addresses.

message str

Optional message to be added in the email. Length is limited to 250 characters.

subject String

Subject of the email. Length is limited to 70 characters.

to List<String>

Array of email addresses.

message String

Optional message to be added in the email. Length is limited to 250 characters.

SchedulePropertiesResponse

EndDate string

The end date and time of the scheduled action (UTC).

Frequency string

Frequency of the schedule.

StartDate string

The start date and time of the scheduled action (UTC).

DayOfMonth int

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.

DaysOfWeek List<string>

Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.

HourOfDay int

UTC time at which cost analysis data will be emailed.

WeeksOfMonth List<string>

Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.

EndDate string

The end date and time of the scheduled action (UTC).

Frequency string

Frequency of the schedule.

StartDate string

The start date and time of the scheduled action (UTC).

DayOfMonth int

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.

DaysOfWeek []string

Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.

HourOfDay int

UTC time at which cost analysis data will be emailed.

WeeksOfMonth []string

Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.

endDate String

The end date and time of the scheduled action (UTC).

frequency String

Frequency of the schedule.

startDate String

The start date and time of the scheduled action (UTC).

dayOfMonth Integer

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.

daysOfWeek List<String>

Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.

hourOfDay Integer

UTC time at which cost analysis data will be emailed.

weeksOfMonth List<String>

Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.

endDate string

The end date and time of the scheduled action (UTC).

frequency string

Frequency of the schedule.

startDate string

The start date and time of the scheduled action (UTC).

dayOfMonth number

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.

daysOfWeek string[]

Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.

hourOfDay number

UTC time at which cost analysis data will be emailed.

weeksOfMonth string[]

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_month int

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_week Sequence[str]

Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.

hour_of_day int

UTC time at which cost analysis data will be emailed.

weeks_of_month Sequence[str]

Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.

endDate String

The end date and time of the scheduled action (UTC).

frequency String

Frequency of the schedule.

startDate String

The start date and time of the scheduled action (UTC).

dayOfMonth Number

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.

daysOfWeek List<String>

Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.

hourOfDay Number

UTC time at which cost analysis data will be emailed.

weeksOfMonth List<String>

Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.

SystemDataResponse

CreatedAt string

The timestamp of resource creation (UTC).

CreatedBy string

The identity that created the resource.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

The type of identity that last modified the resource.

CreatedAt string

The timestamp of resource creation (UTC).

CreatedBy string

The identity that created the resource.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

The type of identity that last modified the resource.

createdAt String

The timestamp of resource creation (UTC).

createdBy String

The identity that created the resource.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

The type of identity that last modified the resource.

createdAt string

The timestamp of resource creation (UTC).

createdBy string

The identity that created the resource.

createdByType string

The type of identity that created the resource.

lastModifiedAt string

The timestamp of resource last modification (UTC)

lastModifiedBy string

The identity that last modified the resource.

lastModifiedByType string

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_type str

The type of identity that created the resource.

last_modified_at str

The timestamp of resource last modification (UTC)

last_modified_by str

The identity that last modified the resource.

last_modified_by_type str

The type of identity that last modified the resource.

createdAt String

The timestamp of resource creation (UTC).

createdBy String

The identity that created the resource.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

The type of identity that last modified the resource.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0