-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.resourcemanager.consumption.models.UsageDetails.yml
63 lines (63 loc) · 8.31 KB
/
com.azure.resourcemanager.consumption.models.UsageDetails.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
### YamlMime:JavaType
uid: "com.azure.resourcemanager.consumption.models.UsageDetails"
fullName: "com.azure.resourcemanager.consumption.models.UsageDetails"
name: "UsageDetails"
nameWithType: "UsageDetails"
summary: "Resource collection API of Usage<wbr>Details."
syntax: "public interface **UsageDetails**"
methods:
- uid: "com.azure.resourcemanager.consumption.models.UsageDetails.list(java.lang.String)"
fullName: "com.azure.resourcemanager.consumption.models.UsageDetails.list(String scope)"
name: "list(String scope)"
nameWithType: "UsageDetails.list(String scope)"
summary: "Lists the usage details for the defined scope."
modifiers:
- "abstract"
parameters:
- description: "The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/'\n for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account\n scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope,\n '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and\n '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For\n subscription, billing account, department, enrollment account and management group, you can also add billing\n period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to\n specify billing period at department scope use\n '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'.\n Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}'\n for billingAccount scope,\n '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for\n billingProfile scope,\n 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}'\n for invoiceSection scope, and\n 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for\n partners."
name: "scope"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract PagedIterable<UsageDetail> list(String scope)"
desc: "Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later."
returns:
description: "result of listing usage details."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.consumption.models.UsageDetail?alt=com.azure.resourcemanager.consumption.models.UsageDetail&text=UsageDetail\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.consumption.models.UsageDetails.list(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,com.azure.resourcemanager.consumption.models.Metrictype,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.consumption.models.UsageDetails.list(String scope, String expand, String filter, String skiptoken, Integer top, Metrictype metric, Context context)"
name: "list(String scope, String expand, String filter, String skiptoken, Integer top, Metrictype metric, Context context)"
nameWithType: "UsageDetails.list(String scope, String expand, String filter, String skiptoken, Integer top, Metrictype metric, Context context)"
summary: "Lists the usage details for the defined scope."
modifiers:
- "abstract"
parameters:
- description: "The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/'\n for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account\n scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope,\n '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and\n '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For\n subscription, billing account, department, enrollment account and management group, you can also add billing\n period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to\n specify billing period at department scope use\n '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'.\n Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}'\n for billingAccount scope,\n '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for\n billingProfile scope,\n 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}'\n for invoiceSection scope, and\n 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for\n partners."
name: "scope"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "May be used to expand the properties/additionalInfo or properties/meterDetails within a list of\n usage details. By default, these fields are not included when listing usage details."
name: "expand"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "May be used to filter usageDetails by properties/resourceGroup, properties/resourceName,\n properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The\n filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.\n Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter\n accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type."
name: "filter"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Skiptoken is only used if a previous operation returned a partial result. If a previous response\n contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that\n specifies a starting point to use for subsequent calls."
name: "skiptoken"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "May be used to limit the number of results to the most recent N usageDetails."
name: "top"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- description: "Allows to select different type of cost/usage records."
name: "metric"
type: "<xref href=\"com.azure.resourcemanager.consumption.models.Metrictype?alt=com.azure.resourcemanager.consumption.models.Metrictype&text=Metrictype\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract PagedIterable<UsageDetail> list(String scope, String expand, String filter, String skiptoken, Integer top, Metrictype metric, Context context)"
desc: "Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later."
returns:
description: "result of listing usage details."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.consumption.models.UsageDetail?alt=com.azure.resourcemanager.consumption.models.UsageDetail&text=UsageDetail\" data-throw-if-not-resolved=\"False\" />>"
type: "interface"
desc: "Resource collection API of UsageDetails."
metadata: {}
package: "com.azure.resourcemanager.consumption.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-consumption:1.0.0-beta.3