Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. costmanagement
  5. getReport
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.costmanagement.getReport

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    Gets the report for a subscription by report name. Azure REST API version: 2018-08-01-preview.

    Using getReport

    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 getReport(args: GetReportArgs, opts?: InvokeOptions): Promise<GetReportResult>
function getReportOutput(args: GetReportOutputArgs, opts?: InvokeOptions): Output<GetReportResult>
    def get_report(report_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetReportResult
def get_report_output(report_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetReportResult]
    func LookupReport(ctx *Context, args *LookupReportArgs, opts ...InvokeOption) (*LookupReportResult, error)
func LookupReportOutput(ctx *Context, args *LookupReportOutputArgs, opts ...InvokeOption) LookupReportResultOutput

    > Note: This function is named LookupReport in the Go SDK.

    public static class GetReport 
{
    public static Task<GetReportResult> InvokeAsync(GetReportArgs args, InvokeOptions? opts = null)
    public static Output<GetReportResult> Invoke(GetReportInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetReportResult> getReport(GetReportArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:costmanagement:getReport
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ReportName string
    Report Name.
    ReportName string
    Report Name.
    reportName String
    Report Name.
    reportName string
    Report Name.
    report_name str
    Report Name.
    reportName String
    Report Name.

    getReport Result

    The following output properties are available:

    Definition Pulumi.AzureNative.CostManagement.Outputs.ReportDefinitionResponse
    Has definition for the report.
    DeliveryInfo Pulumi.AzureNative.CostManagement.Outputs.ReportDeliveryInfoResponse
    Has delivery information for the report.
    Id string
    Resource Id.
    Name string
    Resource name.
    Tags Dictionary<string, string>
    Resource tags.
    Type string
    Resource type.
    Format string
    The format of the report being delivered.
    Schedule Pulumi.AzureNative.CostManagement.Outputs.ReportScheduleResponse
    Has schedule information for the report.
    Definition ReportDefinitionResponse
    Has definition for the report.
    DeliveryInfo ReportDeliveryInfoResponse
    Has delivery information for the report.
    Id string
    Resource Id.
    Name string
    Resource name.
    Tags map[string]string
    Resource tags.
    Type string
    Resource type.
    Format string
    The format of the report being delivered.
    Schedule ReportScheduleResponse
    Has schedule information for the report.
    definition ReportDefinitionResponse
    Has definition for the report.
    deliveryInfo ReportDeliveryInfoResponse
    Has delivery information for the report.
    id String
    Resource Id.
    name String
    Resource name.
    tags Map<String,String>
    Resource tags.
    type String
    Resource type.
    format String
    The format of the report being delivered.
    schedule ReportScheduleResponse
    Has schedule information for the report.
    definition ReportDefinitionResponse
    Has definition for the report.
    deliveryInfo ReportDeliveryInfoResponse
    Has delivery information for the report.
    id string
    Resource Id.
    name string
    Resource name.
    tags {[key: string]: string}
    Resource tags.
    type string
    Resource type.
    format string
    The format of the report being delivered.
    schedule ReportScheduleResponse
    Has schedule information for the report.
    definition ReportDefinitionResponse
    Has definition for the report.
    delivery_info ReportDeliveryInfoResponse
    Has delivery information for the report.
    id str
    Resource Id.
    name str
    Resource name.
    tags Mapping[str, str]
    Resource tags.
    type str
    Resource type.
    format str
    The format of the report being delivered.
    schedule ReportScheduleResponse
    Has schedule information for the report.
    definition Property Map
    Has definition for the report.
    deliveryInfo Property Map
    Has delivery information for the report.
    id String
    Resource Id.
    name String
    Resource name.
    tags Map<String>
    Resource tags.
    type String
    Resource type.
    format String
    The format of the report being delivered.
    schedule Property Map
    Has schedule information for the report.

    Supporting Types

    ReportAggregationResponse

    Function string
    The name of the aggregation function to use.
    Name string
    The name of the column to aggregate.
    Function string
    The name of the aggregation function to use.
    Name string
    The name of the column to aggregate.
    function String
    The name of the aggregation function to use.
    name String
    The name of the column to aggregate.
    function string
    The name of the aggregation function to use.
    name string
    The name of the column to aggregate.
    function str
    The name of the aggregation function to use.
    name str
    The name of the column to aggregate.
    function String
    The name of the aggregation function to use.
    name String
    The name of the column to aggregate.

    ReportComparisonExpressionResponse

    Name string
    The name of the column to use in comparison.
    Operator string
    The operator to use for comparison.
    Values List<string>
    Array of values to use for comparison
    Name string
    The name of the column to use in comparison.
    Operator string
    The operator to use for comparison.
    Values []string
    Array of values to use for comparison
    name String
    The name of the column to use in comparison.
    operator String
    The operator to use for comparison.
    values List<String>
    Array of values to use for comparison
    name string
    The name of the column to use in comparison.
    operator string
    The operator to use for comparison.
    values string[]
    Array of values to use for comparison
    name str
    The name of the column to use in comparison.
    operator str
    The operator to use for comparison.
    values Sequence[str]
    Array of values to use for comparison
    name String
    The name of the column to use in comparison.
    operator String
    The operator to use for comparison.
    values List<String>
    Array of values to use for comparison

    ReportDatasetConfigurationResponse

    Columns List<string>
    Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns.
    Columns []string
    Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns.
    columns List<String>
    Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns.
    columns string[]
    Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns.
    columns Sequence[str]
    Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns.
    columns List<String>
    Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns.

    ReportDatasetResponse

    Aggregation Dictionary<string, Pulumi.AzureNative.CostManagement.Inputs.ReportAggregationResponse>
    Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.
    Configuration Pulumi.AzureNative.CostManagement.Inputs.ReportDatasetConfigurationResponse
    Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided.
    Filter Pulumi.AzureNative.CostManagement.Inputs.ReportFilterResponse
    Has filter expression to use in the report.
    Granularity string
    The granularity of rows in the report.
    Grouping List<Pulumi.AzureNative.CostManagement.Inputs.ReportGroupingResponse>
    Array of group by expression to use in the report. Report can have up to 2 group by clauses.
    Aggregation map[string]ReportAggregationResponse
    Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.
    Configuration ReportDatasetConfigurationResponse
    Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided.
    Filter ReportFilterResponse
    Has filter expression to use in the report.
    Granularity string
    The granularity of rows in the report.
    Grouping []ReportGroupingResponse
    Array of group by expression to use in the report. Report can have up to 2 group by clauses.
    aggregation Map<String,ReportAggregationResponse>
    Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.
    configuration ReportDatasetConfigurationResponse
    Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided.
    filter ReportFilterResponse
    Has filter expression to use in the report.
    granularity String
    The granularity of rows in the report.
    grouping List<ReportGroupingResponse>
    Array of group by expression to use in the report. Report can have up to 2 group by clauses.
    aggregation {[key: string]: ReportAggregationResponse}
    Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.
    configuration ReportDatasetConfigurationResponse
    Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided.
    filter ReportFilterResponse
    Has filter expression to use in the report.
    granularity string
    The granularity of rows in the report.
    grouping ReportGroupingResponse[]
    Array of group by expression to use in the report. Report can have up to 2 group by clauses.
    aggregation Mapping[str, ReportAggregationResponse]
    Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.
    configuration ReportDatasetConfigurationResponse
    Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided.
    filter ReportFilterResponse
    Has filter expression to use in the report.
    granularity str
    The granularity of rows in the report.
    grouping Sequence[ReportGroupingResponse]
    Array of group by expression to use in the report. Report can have up to 2 group by clauses.
    aggregation Map<Property Map>
    Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.
    configuration Property Map
    Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided.
    filter Property Map
    Has filter expression to use in the report.
    granularity String
    The granularity of rows in the report.
    grouping List<Property Map>
    Array of group by expression to use in the report. Report can have up to 2 group by clauses.

    ReportDefinitionResponse

    Timeframe string
    The time frame for pulling data for the report. If custom, then a specific time period must be provided.
    Type string
    The type of the report.
    Dataset Pulumi.AzureNative.CostManagement.Inputs.ReportDatasetResponse
    Has definition for data in this report.
    TimePeriod Pulumi.AzureNative.CostManagement.Inputs.ReportTimePeriodResponse
    Has time period for pulling data for the report.
    Timeframe string
    The time frame for pulling data for the report. If custom, then a specific time period must be provided.
    Type string
    The type of the report.
    Dataset ReportDatasetResponse
    Has definition for data in this report.
    TimePeriod ReportTimePeriodResponse
    Has time period for pulling data for the report.
    timeframe String
    The time frame for pulling data for the report. If custom, then a specific time period must be provided.
    type String
    The type of the report.
    dataset ReportDatasetResponse
    Has definition for data in this report.
    timePeriod ReportTimePeriodResponse
    Has time period for pulling data for the report.
    timeframe string
    The time frame for pulling data for the report. If custom, then a specific time period must be provided.
    type string
    The type of the report.
    dataset ReportDatasetResponse
    Has definition for data in this report.
    timePeriod ReportTimePeriodResponse
    Has time period for pulling data for the report.
    timeframe str
    The time frame for pulling data for the report. If custom, then a specific time period must be provided.
    type str
    The type of the report.
    dataset ReportDatasetResponse
    Has definition for data in this report.
    time_period ReportTimePeriodResponse
    Has time period for pulling data for the report.
    timeframe String
    The time frame for pulling data for the report. If custom, then a specific time period must be provided.
    type String
    The type of the report.
    dataset Property Map
    Has definition for data in this report.
    timePeriod Property Map
    Has time period for pulling data for the report.

    ReportDeliveryDestinationResponse

    Container string
    The name of the container where reports will be uploaded.
    ResourceId string
    The resource id of the storage account where reports will be delivered.
    RootFolderPath string
    The name of the directory where reports will be uploaded.
    Container string
    The name of the container where reports will be uploaded.
    ResourceId string
    The resource id of the storage account where reports will be delivered.
    RootFolderPath string
    The name of the directory where reports will be uploaded.
    container String
    The name of the container where reports will be uploaded.
    resourceId String
    The resource id of the storage account where reports will be delivered.
    rootFolderPath String
    The name of the directory where reports will be uploaded.
    container string
    The name of the container where reports will be uploaded.
    resourceId string
    The resource id of the storage account where reports will be delivered.
    rootFolderPath string
    The name of the directory where reports will be uploaded.
    container str
    The name of the container where reports will be uploaded.
    resource_id str
    The resource id of the storage account where reports will be delivered.
    root_folder_path str
    The name of the directory where reports will be uploaded.
    container String
    The name of the container where reports will be uploaded.
    resourceId String
    The resource id of the storage account where reports will be delivered.
    rootFolderPath String
    The name of the directory where reports will be uploaded.

    ReportDeliveryInfoResponse

    Destination ReportDeliveryDestinationResponse
    Has destination for the report being delivered.
    destination ReportDeliveryDestinationResponse
    Has destination for the report being delivered.
    destination ReportDeliveryDestinationResponse
    Has destination for the report being delivered.
    destination ReportDeliveryDestinationResponse
    Has destination for the report being delivered.
    destination Property Map
    Has destination for the report being delivered.

    ReportFilterResponse

    And []ReportFilterResponse
    The logical "AND" expression. Must have at least 2 items.
    Dimension ReportComparisonExpressionResponse
    Has comparison expression for a dimension
    Not ReportFilterResponse
    The logical "NOT" expression.
    Or []ReportFilterResponse
    The logical "OR" expression. Must have at least 2 items.
    Tag ReportComparisonExpressionResponse
    Has comparison expression for a tag
    and List<ReportFilterResponse>
    The logical "AND" expression. Must have at least 2 items.
    dimension ReportComparisonExpressionResponse
    Has comparison expression for a dimension
    not ReportFilterResponse
    The logical "NOT" expression.
    or List<ReportFilterResponse>
    The logical "OR" expression. Must have at least 2 items.
    tag ReportComparisonExpressionResponse
    Has comparison expression for a tag
    and ReportFilterResponse[]
    The logical "AND" expression. Must have at least 2 items.
    dimension ReportComparisonExpressionResponse
    Has comparison expression for a dimension
    not ReportFilterResponse
    The logical "NOT" expression.
    or ReportFilterResponse[]
    The logical "OR" expression. Must have at least 2 items.
    tag ReportComparisonExpressionResponse
    Has comparison expression for a tag
    and_ Sequence[ReportFilterResponse]
    The logical "AND" expression. Must have at least 2 items.
    dimension ReportComparisonExpressionResponse
    Has comparison expression for a dimension
    not_ ReportFilterResponse
    The logical "NOT" expression.
    or_ Sequence[ReportFilterResponse]
    The logical "OR" expression. Must have at least 2 items.
    tag ReportComparisonExpressionResponse
    Has comparison expression for a tag
    and List<Property Map>
    The logical "AND" expression. Must have at least 2 items.
    dimension Property Map
    Has comparison expression for a dimension
    not Property Map
    The logical "NOT" expression.
    or List<Property Map>
    The logical "OR" expression. Must have at least 2 items.
    tag Property Map
    Has comparison expression for a tag

    ReportGroupingResponse

    Name string
    The name of the column to group.
    Type string
    Has type of the column to group.
    Name string
    The name of the column to group.
    Type string
    Has type of the column to group.
    name String
    The name of the column to group.
    type String
    Has type of the column to group.
    name string
    The name of the column to group.
    type string
    Has type of the column to group.
    name str
    The name of the column to group.
    type str
    Has type of the column to group.
    name String
    The name of the column to group.
    type String
    Has type of the column to group.

    ReportRecurrencePeriodResponse

    From string
    The start date of recurrence.
    To string
    The end date of recurrence.
    From string
    The start date of recurrence.
    To string
    The end date of recurrence.
    from String
    The start date of recurrence.
    to String
    The end date of recurrence.
    from string
    The start date of recurrence.
    to string
    The end date of recurrence.
    from_ str
    The start date of recurrence.
    to str
    The end date of recurrence.
    from String
    The start date of recurrence.
    to String
    The end date of recurrence.

    ReportScheduleResponse

    Recurrence string
    The schedule recurrence.
    RecurrencePeriod Pulumi.AzureNative.CostManagement.Inputs.ReportRecurrencePeriodResponse
    Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.
    Status string
    The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused.
    Recurrence string
    The schedule recurrence.
    RecurrencePeriod ReportRecurrencePeriodResponse
    Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.
    Status string
    The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused.
    recurrence String
    The schedule recurrence.
    recurrencePeriod ReportRecurrencePeriodResponse
    Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.
    status String
    The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused.
    recurrence string
    The schedule recurrence.
    recurrencePeriod ReportRecurrencePeriodResponse
    Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.
    status string
    The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused.
    recurrence str
    The schedule recurrence.
    recurrence_period ReportRecurrencePeriodResponse
    Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.
    status str
    The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused.
    recurrence String
    The schedule recurrence.
    recurrencePeriod Property Map
    Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.
    status String
    The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused.

    ReportTimePeriodResponse

    From string
    The start date to pull data from.
    To string
    The end date to pull data to.
    From string
    The start date to pull data from.
    To string
    The end date to pull data to.
    from String
    The start date to pull data from.
    to String
    The end date to pull data to.
    from string
    The start date to pull data from.
    to string
    The end date to pull data to.
    from_ str
    The start date to pull data from.
    to str
    The end date to pull data to.
    from String
    The start date to pull data from.
    to String
    The end date to pull data to.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure-native