Skip to content

Commit e6554d9

Browse files
Matt-WestphalMatt-Westphal
committed
updated help file with formatting from help editor
1 parent 66f51fa commit e6554d9

File tree

1 file changed

+203
-91
lines changed

1 file changed

+203
-91
lines changed

‎src/ResourceManager/Commerce/Commands.UsageAggregates/Microsoft.Azure.Commands.UsageAggregates.dll-help.xml

Lines changed: 203 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,203 @@
1-
<?xml version="1.0" encoding="utf-8"?>
2-
<helpItems xmlns="http://msh" schema="maml">
3-
<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">
4-
<command:details>
5-
<command:name>Get-UsageAggregation</command:name>
6-
<maml:description>
7-
<maml:para>Enables you to query aggregate Azure subscription consumption data.</maml:para>
8-
</maml:description>
9-
<maml:copyright>
10-
<maml:para />
11-
</maml:copyright>
12-
<command:verb>Get</command:verb>
13-
<command:noun>UsageAggregation</command:noun>
14-
<dev:version />
15-
</command:details>
16-
<maml:description>
17-
<maml:para>
18-
The Get-UsageAggregation cmdlet to query aggregate Azure subscription consumption data by:
19-
• Start and end date/time
20-
• Aggregation granularity (ie: daily, hourly)
21-
• Instance level detail (ie: for multiple instances of the same resource)
22-
For more information, see <maml:navigationLink>
23-
<maml:linkText>Azure Billing REST API Reference</maml:linkText>
24-
<maml:uri>https://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c</maml:uri>
25-
</maml:navigationLink>(https://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c) at the Microsoft Developer Network.
26-
</maml:para>
27-
</maml:description>
28-
<command:syntax>
29-
<command:syntaxItem>
30-
<maml:name>Get-UsageAggregation</maml:name>
31-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
32-
<maml:name>ReportedStartTime</maml:name>
33-
<maml:description>
34-
<maml:para>The start of the time range to retrieve data for.</maml:para>
35-
</maml:description>
36-
<command:parameterValue required="true" variableLength="True">DateTime</command:parameterValue>
37-
</command:parameter>
38-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
39-
<maml:name>ReportedEndTime</maml:name>
40-
<maml:description>
41-
<maml:para>The end of the time range to retrieve data for.</maml:para>
42-
</maml:description>
43-
<command:parameterValue required="true" variableLength="True">DateTime</command:parameterValue>
44-
</command:parameter>
45-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
46-
<maml:name>AggregationGranularity</maml:name>
47-
<maml:description>
48-
<maml:para>Value is either daily (default) or hourly to tell the API how to return the results grouped by day or hour.</maml:para>
49-
</maml:description>
50-
<command:parameterValue required="false" variableLength="false">AggregationGranularity</command:parameterValue>
51-
</command:parameter>
52-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
53-
<maml:name>ShowDetails</maml:name>
54-
<maml:description>
55-
<maml:para>When set to true (default), the aggregates are broken down into the instance metadata which is more granular.</maml:para>
56-
</maml:description>
57-
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
58-
</command:parameter>
59-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
60-
<maml:name>ContinuationToken</maml:name>
61-
<maml:description>
62-
<maml:para>Retrieved from previous calls, this is the bookmark used for progress when the responses are paged.</maml:para>
63-
</maml:description>
64-
<command:parameterValue required="true" variableLength="true">String</command:parameterValue>
65-
</command:parameter>
66-
</command:syntaxItem>
67-
</command:syntax>
68-
<command:examples>
69-
<command:example>
70-
<maml:title>Example 1: Retrieves data for subscription</maml:title>
71-
<maml:introduction>
72-
<maml:para>
73-
</maml:para>
74-
</maml:introduction>
75-
<dev:code>
76-
PS C:\&gt;Set-AzureSubscription -SubscriptionId $subscription
77-
PS C:\&gt;Get-UsageAggregation -ReportedStartTime "5/2/2015" -ReportedEndTime "5/5/2015"
78-
</dev:code>
79-
<dev:remarks>
80-
<maml:para>The final command retrieves the usage data for the subscription for the specificed dates of 5/2/2015 and 5/5/2015.</maml:para>
81-
<maml:para></maml:para>
82-
</dev:remarks>
83-
<command:commandLines>
84-
<command:commandLine>
85-
<command:commandText />
86-
</command:commandLine>
87-
</command:commandLines>
88-
</command:example>
89-
</command:examples>
90-
</command:command>
91-
</helpItems>
1+
<?xml version="1.0" encoding="utf-8"?><helpItems schema="maml">
2+
<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">
3+
<!--Generated by PS Cmdlet Help Editor-->
4+
<command:details>
5+
<command:name>Get-UsageAggregates</command:name>
6+
<maml:description>
7+
<maml:para>Enables you to query aggregate Azure subscription consumption data.</maml:para>
8+
</maml:description>
9+
<maml:copyright>
10+
<maml:para />
11+
</maml:copyright>
12+
<command:verb>Get</command:verb>
13+
<command:noun>UsageAggregates</command:noun>
14+
<dev:version />
15+
</command:details>
16+
<maml:description>
17+
<maml:para>
18+
The Get-UsageAggregation cmdlet to query aggregate Azure subscription consumption data by:
19+
• Start and end date/time
20+
• Aggregation granularity (ie: daily, hourly)
21+
• Instance level detail (ie: for multiple instances of the same resource)
22+
For more information, see Azure Billing REST API Reference (https://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c) at the Microsoft Developer Network.</maml:para>
23+
</maml:description>
24+
<command:syntax>
25+
<command:syntaxItem>
26+
<maml:name>Get-UsageAggregates</maml:name>
27+
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
28+
<maml:name>ReportedStartTime</maml:name>
29+
<maml:description>
30+
<maml:para />
31+
</maml:description>
32+
<command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue>
33+
</command:parameter>
34+
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
35+
<maml:name>ReportedEndTime</maml:name>
36+
<maml:description>
37+
<maml:para />
38+
</maml:description>
39+
<command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue>
40+
</command:parameter>
41+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
42+
<maml:name>AggregationGranularity</maml:name>
43+
<maml:description>
44+
<maml:para />
45+
</maml:description>
46+
<command:parameterValue required="true" variableLength="false">AggregationGranularity</command:parameterValue>
47+
</command:parameter>
48+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
49+
<maml:name>ShowDetails</maml:name>
50+
<maml:description>
51+
<maml:para />
52+
</maml:description>
53+
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
54+
</command:parameter>
55+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
56+
<maml:name>ContinuationToken</maml:name>
57+
<maml:description>
58+
<maml:para />
59+
</maml:description>
60+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
61+
</command:parameter>
62+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
63+
<maml:name>Profile</maml:name>
64+
<maml:description>
65+
<maml:para />
66+
</maml:description>
67+
<command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue>
68+
</command:parameter>
69+
</command:syntaxItem>
70+
</command:syntax>
71+
<command:parameters>
72+
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
73+
<maml:name>ReportedStartTime</maml:name>
74+
<maml:description>
75+
<maml:para />
76+
</maml:description>
77+
<command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue>
78+
<dev:type>
79+
<maml:name>DateTime</maml:name>
80+
<maml:uri/>
81+
</dev:type>
82+
<dev:defaultValue></dev:defaultValue>
83+
</command:parameter>
84+
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
85+
<maml:name>ReportedEndTime</maml:name>
86+
<maml:description>
87+
<maml:para />
88+
</maml:description>
89+
<command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue>
90+
<dev:type>
91+
<maml:name>DateTime</maml:name>
92+
<maml:uri/>
93+
</dev:type>
94+
<dev:defaultValue></dev:defaultValue>
95+
</command:parameter>
96+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
97+
<maml:name>AggregationGranularity</maml:name>
98+
<maml:description>
99+
<maml:para />
100+
</maml:description>
101+
<command:parameterValue required="true" variableLength="false">AggregationGranularity</command:parameterValue>
102+
<dev:type>
103+
<maml:name>AggregationGranularity</maml:name>
104+
<maml:uri/>
105+
</dev:type>
106+
<dev:defaultValue></dev:defaultValue>
107+
</command:parameter>
108+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
109+
<maml:name>ShowDetails</maml:name>
110+
<maml:description>
111+
<maml:para />
112+
</maml:description>
113+
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
114+
<dev:type>
115+
<maml:name>Boolean</maml:name>
116+
<maml:uri/>
117+
</dev:type>
118+
<dev:defaultValue></dev:defaultValue>
119+
</command:parameter>
120+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
121+
<maml:name>ContinuationToken</maml:name>
122+
<maml:description>
123+
<maml:para />
124+
</maml:description>
125+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
126+
<dev:type>
127+
<maml:name>String</maml:name>
128+
<maml:uri/>
129+
</dev:type>
130+
<dev:defaultValue></dev:defaultValue>
131+
</command:parameter>
132+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
133+
<maml:name>Profile</maml:name>
134+
<maml:description>
135+
<maml:para />
136+
</maml:description>
137+
<command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue>
138+
<dev:type>
139+
<maml:name>AzureProfile</maml:name>
140+
<maml:uri/>
141+
</dev:type>
142+
<dev:defaultValue></dev:defaultValue>
143+
</command:parameter>
144+
</command:parameters>
145+
<command:inputTypes>
146+
<command:inputType>
147+
<dev:type>
148+
<maml:name></maml:name>
149+
<maml:uri></maml:uri>
150+
<maml:description/>
151+
</dev:type>
152+
<maml:description>
153+
<maml:para />
154+
</maml:description>
155+
</command:inputType>
156+
</command:inputTypes>
157+
<command:returnValues>
158+
<command:returnValue>
159+
<dev:type>
160+
<maml:name></maml:name>
161+
<maml:uri></maml:uri>
162+
<maml:description/>
163+
</dev:type>
164+
<maml:description>
165+
<maml:para />
166+
</maml:description>
167+
</command:returnValue>
168+
</command:returnValues>
169+
<command:terminatingErrors></command:terminatingErrors>
170+
<command:nonTerminatingErrors></command:nonTerminatingErrors>
171+
<maml:alertSet>
172+
<maml:title></maml:title>
173+
<maml:alert>
174+
<maml:para />
175+
</maml:alert>
176+
</maml:alertSet>
177+
<command:examples>
178+
<command:example>
179+
<maml:title>-------------------------- Example 1: Retrieves data for subscription --------------------------</maml:title>
180+
<maml:introduction>
181+
<maml:paragraph>PS C:\&gt;</maml:paragraph>
182+
</maml:introduction>
183+
<dev:code>PS C:\&gt;Set-AzureSubscription -SubscriptionId $subscription
184+
PS C:\&gt;Get-UsageAggregates -ReportedStartTime &quot;5/2/2015&quot; -ReportedEndTime &quot;5/5/2015&quot;</dev:code>
185+
<dev:remarks>
186+
<maml:para>The final command retrieves the usage data for the subscription for the specificed dates of 5/2/2015 and 5/5/2015.</maml:para>
187+
<maml:para />
188+
<maml:para />
189+
<maml:para></maml:para>
190+
</dev:remarks>
191+
<command:commandLines>
192+
<command:commandLine>
193+
<command:commandText>
194+
<maml:para />
195+
</command:commandText>
196+
</command:commandLine>
197+
</command:commandLines>
198+
</command:example>
199+
</command:examples>
200+
<maml:relatedLinks>
201+
</maml:relatedLinks>
202+
</command:command>
203+
</helpItems>

0 commit comments

Comments
 (0)