-
Notifications
You must be signed in to change notification settings - Fork 180
/
UsageDetails.yml
58 lines (57 loc) · 3.16 KB
/
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
### YamlMime:TSType
name: UsageDetails
uid: '@azure/arm-consumption.UsageDetails'
package: '@azure/arm-consumption'
summary: Interface representing a UsageDetails.
fullName: UsageDetails
remarks: ''
isDeprecated: false
type: interface
methods:
- name: list(string, UsageDetailsListOptionalParams)
uid: '@azure/arm-consumption.UsageDetails.list'
package: '@azure/arm-consumption'
summary: >-
Lists the usage details for the defined scope. Usage details are available
via this API only for May
1, 2014 or later.
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(scope: string, options?: UsageDetailsListOptionalParams):
PagedAsyncIterableIterator<UsageDetailUnion, UsageDetailUnion[],
PageSettings>
parameters:
- id: scope
type: string
description: |-
The scope associated with usage details operations. This includes
'/subscriptions/{subscriptionId}/' for subscription scope,
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope,
'/providers/Microsoft.Billing/departments/{departmentId}' for Department scope,
'/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope
and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group
scope. For subscription, billing account, department, enrollment account and management group, you
can also add billing period to the scope using
'/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing
period at department scope use
'/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'.
Also, Modern Commerce Account scopes are
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope,
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}'
for billingProfile scope,
'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}'
for invoiceSection scope, and
'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for
partners.
- id: options
type: <xref uid="@azure/arm-consumption.UsageDetailsListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-consumption.UsageDetailUnion" />, <xref
uid="@azure/arm-consumption.UsageDetailUnion" />[], <xref
uid="@azure/core-paging.PageSettings" />>