Az.Billing

2.0.0

Microsoft.Azure.PowerShell.Cmdlets.UsageAggregates.dll-Help.xml

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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 <?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Get-UsageAggregates</command:name>
      <command:verb>Get</command:verb>
      <command:noun>UsageAggregates</command:noun>
      <maml:description>
        <maml:para>Gets the reported Azure subscription usage details.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>The Get-UsageAggregates cmdlet gets aggregated Azure subscription usage data by the following properties: - Start and end times of when the usage was reported.</maml:para>
      <maml:para>- Aggregation precision, either daily or hourly.</maml:para>
      <maml:para>- Instance level detail for multiple instances of the same resource.</maml:para>
      <maml:para>For consistent results, the returned data is based on when the usage details were reported by the Azure resource. For more information, see Azure Billing REST API Referencehttps://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c (https://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c) in the Microsoft Developer Network library.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-UsageAggregates</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>AggregationGranularity</maml:name>
          <maml:Description>
            <maml:para>Specifies the aggregation precision of the data. Valid values are: Daily and Hourly. The default value is Daily.</maml:para>
          </maml:Description>
          <command:parameterValueGroup>
            <command:parameterValue required="false" command:variableLength="false">Daily</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">Hourly</command:parameterValue>
          </command:parameterValueGroup>
          <command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commerce.UsageAggregates.Models.AggregationGranularity</command:parameterValue>
          <dev:type>
            <maml:name>Microsoft.Azure.Commerce.UsageAggregates.Models.AggregationGranularity</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>ContinuationToken</maml:name>
          <maml:Description>
            <maml:para>Specifies the continuation token that was retrieved from the response body in the previous call. For a large result set, responses are paged by using continuation tokens. The continuation token serves as a bookmark for progress. If you do not specify this parameter, the data is retrieved from the beginning of the day or hour specified in ReportedStartTime . We recommend that you follow the next link in the response to page though the data.</maml:para>
          </maml:Description>
          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
          <maml:name>DefaultProfile</maml:name>
          <maml:Description>
            <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para>
          </maml:Description>
          <command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
          <dev:type>
            <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>ReportedEndTime</maml:name>
          <maml:Description>
            <maml:para>Specifies the reported end time for when resource usage was recorded in the Azure billing system. Azure is a distributed system, spanning multiple datacenters around the world, so there is a delay between when the resource was actually consumed, which is the resource usage time, and when the usage event reached the billing system, which is the resource usage reported time. In order to get all usage events for a subscription that are reported for a time period, you query by reported time. Even though you query by reported time, the cmdlet aggregates the response data by the resource usage time. The resource usage data is the useful pivot for analyzing the data.</maml:para>
          </maml:Description>
          <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue>
          <dev:type>
            <maml:name>System.DateTime</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>ReportedStartTime</maml:name>
          <maml:Description>
            <maml:para>Specifies the reported start time for when resource usage was recorded in the Azure billing system.</maml:para>
          </maml:Description>
          <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue>
          <dev:type>
            <maml:name>System.DateTime</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>ShowDetails</maml:name>
          <maml:Description>
            <maml:para>Indicates whether this cmdlet returns instance-level details with the usage data. The default value is $True. If $False, the service aggregates the results on the server side, and therefore returns fewer aggregate groups. For example, if you are running three websites, by default you will get three line items for website consumption. However, when the value is $False, all the data for the same subscriptionId , meterId , usageStartTime , and usageEndTime is collapsed into a single line item.</maml:para>
          </maml:Description>
          <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
          <dev:type>
            <maml:name>System.Boolean</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>AggregationGranularity</maml:name>
        <maml:Description>
          <maml:para>Specifies the aggregation precision of the data. Valid values are: Daily and Hourly. The default value is Daily.</maml:para>
        </maml:Description>
        <command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commerce.UsageAggregates.Models.AggregationGranularity</command:parameterValue>
        <dev:type>
          <maml:name>Microsoft.Azure.Commerce.UsageAggregates.Models.AggregationGranularity</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>ContinuationToken</maml:name>
        <maml:Description>
          <maml:para>Specifies the continuation token that was retrieved from the response body in the previous call. For a large result set, responses are paged by using continuation tokens. The continuation token serves as a bookmark for progress. If you do not specify this parameter, the data is retrieved from the beginning of the day or hour specified in ReportedStartTime . We recommend that you follow the next link in the response to page though the data.</maml:para>
        </maml:Description>
        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
        <maml:name>DefaultProfile</maml:name>
        <maml:Description>
          <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para>
        </maml:Description>
        <command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
        <dev:type>
          <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>ReportedEndTime</maml:name>
        <maml:Description>
          <maml:para>Specifies the reported end time for when resource usage was recorded in the Azure billing system. Azure is a distributed system, spanning multiple datacenters around the world, so there is a delay between when the resource was actually consumed, which is the resource usage time, and when the usage event reached the billing system, which is the resource usage reported time. In order to get all usage events for a subscription that are reported for a time period, you query by reported time. Even though you query by reported time, the cmdlet aggregates the response data by the resource usage time. The resource usage data is the useful pivot for analyzing the data.</maml:para>
        </maml:Description>
        <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue>
        <dev:type>
          <maml:name>System.DateTime</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>ReportedStartTime</maml:name>
        <maml:Description>
          <maml:para>Specifies the reported start time for when resource usage was recorded in the Azure billing system.</maml:para>
        </maml:Description>
        <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue>
        <dev:type>
          <maml:name>System.DateTime</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>ShowDetails</maml:name>
        <maml:Description>
          <maml:para>Indicates whether this cmdlet returns instance-level details with the usage data. The default value is $True. If $False, the service aggregates the results on the server side, and therefore returns fewer aggregate groups. For example, if you are running three websites, by default you will get three line items for website consumption. However, when the value is $False, all the data for the same subscriptionId , meterId , usageStartTime , and usageEndTime is collapsed into a single line item.</maml:para>
        </maml:Description>
        <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
        <dev:type>
          <maml:name>System.Boolean</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregationGetResponse</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>------------ Example 1: Retrieve subscription data ------------</maml:title>
        <dev:code>PS C:\&gt;Get-UsageAggregates -ReportedStartTime "5/2/2015" -ReportedEndTime "5/5/2015"</dev:code>
        <dev:remarks>
          <maml:para>This command retrieves the reported usage data for the subscription between 5/2/2015 and 5/5/2015.</maml:para>
<maml:para></maml:para>
<maml:para></maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>https://docs.microsoft.com/en-us/powershell/module/az.billing/get-usageaggregates</maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>