ArmCarbonOptimizationModelFactory.ItemDetailsQueryFilter Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Initializes a new instance of ItemDetailsQueryFilter.
public static Azure.ResourceManager.CarbonOptimization.Models.ItemDetailsQueryFilter ItemDetailsQueryFilter(Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionQueryDateRange dateRange = default, System.Collections.Generic.IEnumerable<string> subscriptionList = default, System.Collections.Generic.IEnumerable<string> resourceGroupUrlList = default, System.Collections.Generic.IEnumerable<Azure.Core.ResourceType> resourceTypeList = default, System.Collections.Generic.IEnumerable<Azure.Core.AzureLocation> locationList = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionScope> carbonScopeList = default, Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionCategoryType categoryType = default, Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionQueryOrderByColumn orderBy = default, Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionQuerySortDirection sortDirection = default, int pageSize = 0, string skipToken = default);static member ItemDetailsQueryFilter : Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionQueryDateRange * seq<string> * seq<string> * seq<Azure.Core.ResourceType> * seq<Azure.Core.AzureLocation> * seq<Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionScope> * Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionCategoryType * Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionQueryOrderByColumn * Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionQuerySortDirection * int * string -> Azure.ResourceManager.CarbonOptimization.Models.ItemDetailsQueryFilterPublic Shared Function ItemDetailsQueryFilter (Optional dateRange As CarbonEmissionQueryDateRange = Nothing, Optional subscriptionList As IEnumerable(Of String) = Nothing, Optional resourceGroupUrlList As IEnumerable(Of String) = Nothing, Optional resourceTypeList As IEnumerable(Of ResourceType) = Nothing, Optional locationList As IEnumerable(Of AzureLocation) = Nothing, Optional carbonScopeList As IEnumerable(Of CarbonEmissionScope) = Nothing, Optional categoryType As CarbonEmissionCategoryType = Nothing, Optional orderBy As CarbonEmissionQueryOrderByColumn = Nothing, Optional sortDirection As CarbonEmissionQuerySortDirection = Nothing, Optional pageSize As Integer = 0, Optional skipToken As String = Nothing) As ItemDetailsQueryFilterParameters
- dateRange
- CarbonEmissionQueryDateRange
The start and end dates for carbon emissions data. Required. For ItemDetailsReport and TopItemsSummaryReport, only one month of data is supported at a time, so start and end dates should be equal within DateRange (e.g., start: 2024-06-01 and end: 2024-06-01).
- subscriptionList
- IEnumerable<String>
List of subscription IDs for which carbon emissions data is requested. Required. Each subscription ID should be in lowercase format. The max length of list is 100.
- resourceGroupUrlList
- IEnumerable<String>
List of resource group URLs for carbon emissions data. Optional. Each URL must follow the format '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}', and should be in all lowercase.
- resourceTypeList
- IEnumerable<ResourceType>
List of resource types for carbon emissions data. Optional. Each resource type should be specified in lowercase, following the format 'microsoft.{service}/{resourceType}', e.g., 'microsoft.storage/storageaccounts'.
- locationList
- IEnumerable<AzureLocation>
List of locations(Azure Region Display Name) for carbon emissions data, with each location specified in lowercase (e.g., 'east us'). Optional. You can use the command 'az account list-locations -o table' to find Azure Region Display Names.
- carbonScopeList
- IEnumerable<CarbonEmissionScope>
List of carbon emission scopes. Required. Accepts one or more values from EmissionScopeEnum (e.g., Scope1, Scope2, Scope3) in list form. The output will include the total emissions for the specified scopes.
- categoryType
- CarbonEmissionCategoryType
Specifies the category type for detailed emissions data, such as Resource, ResourceGroup, ResourceType, Location, or Subscription. See supported types in CategoryTypeEnum.
- orderBy
- CarbonEmissionQueryOrderByColumn
The column name to order the results by. See supported values in OrderByColumnEnum.
- sortDirection
- CarbonEmissionQuerySortDirection
Direction for sorting results. See supported values in SortDirectionEnum.
- pageSize
- Int32
Number of items to return in one request, max value is 5000.
- skipToken
- String
Pagination token for fetching the next page of data. This token is nullable and will be returned in the previous response if additional data pages are available.
Returns
A new ItemDetailsQueryFilter instance for mocking.
