Package com.azure.resourcemanager.costmanagement.models

Interface ScheduledAction

public interface ScheduledAction
An immutable client-side representation of ScheduledAction.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    ScheduledAction.Definition
    The entirety of the ScheduledAction definition.
    static interface 
    ScheduledAction.DefinitionStages
    The ScheduledAction definition stages.
    static interface 
    ScheduledAction.Update
    The template for ScheduledAction update.
    static interface 
    ScheduledAction.UpdateStages
    The ScheduledAction update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    displayName()
    Gets the displayName property: Scheduled action name.
    String
    etag()
    Gets the etag property: Resource Etag.
    FileDestination
    fileDestination()
    Gets the fileDestination property: Destination format of the view data.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    ScheduledActionInner
    innerModel()
    Gets the inner com.azure.resourcemanager.costmanagement.fluent.models.ScheduledActionInner object.
    ScheduledActionKind
    kind()
    Gets the kind property: Kind of the scheduled action.
    String
    name()
    Gets the name property: The name of the resource.
    NotificationProperties
    notification()
    Gets the notification property: Notification properties based on scheduled action kind.
    String
    notificationEmail()
    Gets the notificationEmail property: Email address of the point of contact that should get the unsubscribe requests and notification emails.
    ScheduledAction
    refresh()
    Refreshes the resource to sync with Azure.
    ScheduledAction
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    void
    runByScope()
    Runs a shared scheduled action within the given scope.
    com.azure.core.http.rest.Response<Void>
    runByScopeWithResponse(com.azure.core.util.Context context)
    Runs a shared scheduled action within the given scope.
    ScheduleProperties
    schedule()
    Gets the schedule property: Schedule of the scheduled action.
    String
    scope()
    Gets the scope property: 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.
    ScheduledActionStatus
    status()
    Gets the status property: Status of the scheduled action.
    com.azure.core.management.SystemData
    systemData()
    Gets the systemData property: Kind of the scheduled action.
    String
    type()
    Gets the type property: The type of the resource.
    ScheduledAction.Update
    update()
    Begins update for the ScheduledAction resource.
    String
    viewId()
    Gets the viewId property: Cost analysis viewId used for scheduled action.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • etag

      String etag()
      Gets the etag property: Resource Etag. For update calls, eTag is mandatory. Fetch the resource's eTag by doing a 'GET' call first and then including the latest eTag as part of the request body or 'If-Match' header while performing the update. For create calls, eTag is not required.
      Returns:
      the etag value.

    • kind

      ScheduledActionKind kind()
      Gets the kind property: Kind of the scheduled action.
      Returns:
      the kind value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Kind of the scheduled action.
      Returns:
      the systemData value.

    • displayName

      String displayName()
      Gets the displayName property: Scheduled action name.
      Returns:
      the displayName value.

    • fileDestination

      FileDestination fileDestination()
      Gets the fileDestination property: Destination format of the view data. This is optional.
      Returns:
      the fileDestination value.

    • notification

      NotificationProperties notification()
      Gets the notification property: Notification properties based on scheduled action kind.
      Returns:
      the notification value.

    • notificationEmail

      String notificationEmail()
      Gets the notificationEmail property: Email address of the point of contact that should get the unsubscribe requests and notification emails.
      Returns:
      the notificationEmail value.

    • schedule

      ScheduleProperties schedule()
      Gets the schedule property: Schedule of the scheduled action.
      Returns:
      the schedule value.

    • scope

      String scope()
      Gets the scope property: 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.
      Returns:
      the scope value.

    • status

      ScheduledActionStatus status()
      Gets the status property: Status of the scheduled action.
      Returns:
      the status value.

    • viewId

      String viewId()
      Gets the viewId property: Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'.
      Returns:
      the viewId value.

    • innerModel

      ScheduledActionInner innerModel()
      Gets the inner com.azure.resourcemanager.costmanagement.fluent.models.ScheduledActionInner object.
      Returns:
      the inner object.

    • update

      ScheduledAction.Update update()
      Begins update for the ScheduledAction resource.
      Returns:
      the stage of resource update.

    • refresh

      ScheduledAction refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      ScheduledAction refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • runByScopeWithResponse

      com.azure.core.http.rest.Response<Void> runByScopeWithResponse(com.azure.core.util.Context context)
      Runs a shared scheduled action within the given scope.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • runByScope

      void runByScope()
      Runs a shared scheduled action within the given scope.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.