Skip to content

Commit 66f51fa

Browse files
ldattiloldattilo
committed
Edit help file.
1 parent db579db commit 66f51fa

File tree

1 file changed

+87
-233
lines changed

1 file changed

+87
-233
lines changed

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

Lines changed: 87 additions & 233 deletions
Original file line numberDiff line numberDiff line change
@@ -1,237 +1,91 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<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 by.</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>The Get-UsageAggregation cmdlet to query aggregate Azure subscription consumption data by:
18-
• Start and end date/time
19-
• Aggregation granularity (ie: daily, hourly)
20-
• Instance level detail (ie: for multiple instances of the same resource)
21-
For more information, see <maml:navigationLink><maml:linkText>Azure Billing REST API Reference</maml:linkText><maml:uri>https://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c</maml:uri></maml:navigationLink>(https://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c) at the Microsoft Developer Network.</maml:para>
22-
</maml:description>
23-
<command:syntax>
24-
<command:syntaxItem>
25-
<maml:name>Get-UsageAggregation</maml:name>
26-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
27-
<maml:name>ReportedStartTime</maml:name>
28-
<maml:description>
29-
<maml:para>The start of the time range to retrieve data for.</maml:para>
30-
</maml:description>
31-
<command:parameterValue required="true" variableLength="True">[DateTime]</command:parameterValue>
32-
</command:parameter>
33-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
34-
<maml:name>ReportedEndTime</maml:name>
35-
<maml:description>
36-
<maml:para>The end of the time range to retrieve data for.</maml:para>
37-
</maml:description>
38-
<command:parameterValue required="true" variableLength="True">[DateTime]</command:parameterValue>
39-
</command:parameter>
40-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
41-
<maml:name>AggregationGranularity</maml:name>
42-
<maml:description>
43-
<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>
44-
</maml:description>
45-
<command:parameterValue required="false" variableLength="false">AggregationGranularity</command:parameterValue>
46-
</command:parameter>
47-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
48-
<maml:name>ShowDetails</maml:name>
49-
<maml:description>
50-
<maml:para>When set to true (default), the aggregates are broken down into the instance metadata which is more granular.</maml:para>
51-
</maml:description>
52-
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
53-
</command:parameter>
54-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
55-
<maml:name>ContinuationToken</maml:name>
56-
<maml:description>
57-
<maml:para>Retrieved from previous calls, this is the bookmark used for progress when the responses are paged.</maml:para>
58-
</maml:description>
59-
<command:parameterValue required="true" variableLength="true">String</command:parameterValue>
60-
</command:parameter>
61-
</command:syntaxItem>
62-
</command:syntax>
63-
<command:parameters>
64-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
65-
<maml:name>EndpointLocation</maml:name>
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>
6616
<maml:description>
67-
<maml:para>Specifies the location of the external endpoint. Specify this parameter for profiles that have a value of Performance for the TrafficRoutingMethod parameter. </maml:para>
68-
<maml:para>You must specify for endpoints of the type ExternalEndpoints in a profile that has the load balancing method of Performance.</maml:para>
69-
<maml:para>You can find a list of possible values for this parameter by using the List Locations operation. For more information, see <maml:navigationLink><maml:linkText>List Locations</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://msdn.microsoft.com/en-us/library/gg441293.aspx) at the Microsoft Developer Network.</maml:para>
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>
7027
</maml:description>
71-
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
72-
<dev:type>
73-
<maml:name>String</maml:name>
74-
<maml:uri />
75-
</dev:type>
76-
<dev:defaultValue>none</dev:defaultValue>
77-
</command:parameter>
78-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
79-
<maml:name>EndpointName</maml:name>
80-
<maml:description>
81-
<maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet adds.</maml:para>
82-
</maml:description>
83-
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
84-
<dev:type>
85-
<maml:name>String</maml:name>
86-
<maml:uri />
87-
</dev:type>
88-
<dev:defaultValue>none</dev:defaultValue>
89-
</command:parameter>
90-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
91-
<maml:name>EndpointStatus</maml:name>
92-
<maml:description>
93-
<maml:para>Specifies the status of the endpoint. If the status is Enabled, the endpoint is probed for endpoint health and is included in the traffic routing method. Valid values are:
94-
95-
-- Enabled
96-
-- Disabled</maml:para>
97-
</maml:description>
98-
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
99-
<dev:type>
100-
<maml:name>String</maml:name>
101-
<maml:uri />
102-
</dev:type>
103-
<dev:defaultValue>none</dev:defaultValue>
104-
</command:parameter>
105-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
106-
<maml:name>Priority</maml:name>
107-
<maml:description>
108-
<maml:para>Specifies the priority that Traffic Manager assigns to the endpoint. Specify this parameter only if the Traffic Manager profile is configured for priority traffic routing. Valid values are integers from 1 through 1000. Lower values represent higher priority.</maml:para>
109-
<maml:para>If you specify a priority, you must specify priorities on all endpoints, and no two endpoints can share the same priority value. If you do not specify priorities, Traffic Manager assigns endpoints with default priority values, starting with one (1), in the order the profile lists the endpoints.</maml:para>
110-
</maml:description>
111-
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
112-
<dev:type>
113-
<maml:name>UInt32</maml:name>
114-
<maml:uri />
115-
</dev:type>
116-
<dev:defaultValue>none</dev:defaultValue>
117-
</command:parameter>
118-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
119-
<maml:name>Profile</maml:name>
120-
<maml:description>
121-
<maml:para>Specifies an Azure profile.</maml:para>
122-
</maml:description>
123-
<command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue>
124-
<dev:type>
125-
<maml:name>AzureProfile</maml:name>
126-
<maml:uri />
127-
</dev:type>
128-
<dev:defaultValue>none</dev:defaultValue>
129-
</command:parameter>
130-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
131-
<maml:name>Target</maml:name>
132-
<maml:description>
133-
<maml:para>Specifies the fully qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses when it directs traffic to this endpoint. </maml:para>
134-
</maml:description>
135-
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
136-
<dev:type>
137-
<maml:name>String</maml:name>
138-
<maml:uri />
139-
</dev:type>
140-
<dev:defaultValue>none</dev:defaultValue>
141-
</command:parameter>
142-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none">
143-
<maml:name>TrafficManagerProfile</maml:name>
144-
<maml:description>
145-
<maml:para>Specifies a local TrafficManagerProfile object. This cmdlet modifies this local object. </maml:para>
146-
</maml:description>
147-
<command:parameterValue required="true" variableLength="false">TrafficManagerProfile</command:parameterValue>
148-
<dev:type>
149-
<maml:name>TrafficManagerProfile</maml:name>
150-
<maml:uri />
151-
</dev:type>
152-
<dev:defaultValue>none</dev:defaultValue>
153-
</command:parameter>
154-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
155-
<maml:name>Type</maml:name>
156-
<maml:description>
157-
<maml:para>Specifies the type of endpoint that this cmdlet adds to the Azure Traffic Manager profile. Valid values are:
158-
159-
-- AzureEndpoints
160-
-- ExternalEndpoints
161-
-- NestedEndpoints</maml:para>
162-
<maml:para>Azure Resource Manager is currently in Preview. The only supported type is ExternalEndpoints.</maml:para>
163-
</maml:description>
164-
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
165-
<dev:type>
166-
<maml:name>String</maml:name>
167-
<maml:uri />
168-
</dev:type>
169-
<dev:defaultValue>none</dev:defaultValue>
170-
</command:parameter>
171-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
172-
<maml:name>Weight</maml:name>
173-
<maml:description>
174-
<maml:para>Specifies the weight that Traffic Manager assigns to the endpoint. Valid values are integers from 1 through 1000. The default value is one (1). Specify this parameter only if the Traffic Manager profile has a value of Weighted for the TrafficRoutingMethod parameter. </maml:para>
175-
</maml:description>
176-
<command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
177-
<dev:type>
178-
<maml:name>UInt32</maml:name>
179-
<maml:uri />
180-
</dev:type>
181-
<dev:defaultValue>none</dev:defaultValue>
182-
</command:parameter>
183-
</command:parameters>
184-
<command:inputTypes>
185-
<command:inputType>
186-
<dev:type>
187-
<maml:name>Microsoft.Azure.Commands.Network.TrafficManagerProfile</maml:name>
188-
<maml:uri>
189-
</maml:uri>
190-
<maml:description>
191-
<maml:para />
192-
</maml:description>
193-
</dev:type>
194-
<maml:description>
195-
<maml:para>You can pipe a TrafficManagerProfile object to this cmdlet. </maml:para>
196-
</maml:description>
197-
</command:inputType>
198-
</command:inputTypes>
199-
<command:returnValues>
200-
<command:returnValue>
201-
<dev:type>
202-
<maml:name>Microsoft.Azure.Commands.Network.TrafficManagerProfile</maml:name>
203-
<maml:uri>
204-
</maml:uri>
205-
<maml:description>
206-
<maml:para />
207-
</maml:description>
208-
</dev:type>
209-
<maml:description>
210-
<maml:para>This cmdlet returns a modified TrafficManagerProfile object.</maml:para>
211-
</maml:description>
212-
</command:returnValue>
213-
</command:returnValues>
214-
<command:terminatingErrors />
215-
<command:nonTerminatingErrors />
216-
<command:examples>
217-
<command:example>
218-
<maml:title>Example 1: Retrieves data for subscription</maml:title>
219-
<maml:introduction>
220-
<maml:para>
221-
</maml:para>
222-
</maml:introduction>
223-
<dev:code>PS C:\&gt;Set-AzureSubscription -SubscriptionId $subscription
224-
PS C:\&gt;$useAggregation = Get-UsageAggregation -ReportedStartTime "5/2/2015" -ReportedEndTime "5/5/2015"</dev:code>
225-
<dev:remarks>
226-
<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>
227-
<maml:para></maml:para>
228-
</dev:remarks>
229-
<command:commandLines>
230-
<command:commandLine>
231-
<command:commandText />
232-
</command:commandLine>
233-
</command:commandLines>
234-
</command:example>
235-
</command:examples>
236-
</command:command>
237-
</helpItems>
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>

0 commit comments

Comments
 (0)