Skip to content

Commit 5bfbe9e

Browse files
author
Michael Flanakin
committed
Generate PowerShell docs from code
1 parent fdd5a6c commit 5bfbe9e

20 files changed

+649
-426
lines changed

‎docs/_automation/powershell/cost/Get-FinOpsCostExport.md‎

Lines changed: 35 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ layout: default
33
grand_parent: PowerShell
44
parent: Cost Management
55
title: Get-FinOpsCostExport
6-
nav_order: 1
7-
description: 'Get a list of Cost Management exports.'
6+
nav_order: 10
7+
description: Get a list of Cost Management exports.
88
permalink: /powershell/cost/Get-FinOpsCostExport
99
---
1010

@@ -20,7 +20,6 @@ Get a list of Cost Management exports.
2020

2121
- [🧮 Syntax](#-syntax)
2222
- [📥 Parameters](#-parameters)
23-
- [📤 Return value](#-return-value)
2423
- [🌟 Examples](#-examples)
2524
- [🧰 Related tools](#-related-tools)
2625

@@ -42,81 +41,37 @@ This command has been tested with the following API versions:
4241

4342
```powershell
4443
Get-FinOpsCostExport `
45-
[-Name <string>] `
46-
[-Scope <string>] `
47-
[-DataSet <string>] `
48-
[-StorageAccountId <string>] `
49-
[-StorageContainer <string>] `
50-
[-RunHistory] `
51-
[-ApiVersion <string>]
44+
[[‑Name] <String>] `
45+
[‑Scope <String>] `
46+
[‑Dataset <String>] `
47+
[‑DatasetVersion <String>] `
48+
[‑StorageAccountId <String>] `
49+
[‑StorageContainer <String>] `
50+
[‑RunHistory] `
51+
[‑ApiVersion <String>] `
52+
[<CommonParameters>]
5253
```
5354

5455
<br>
5556

5657
## 📥 Parameters
5758

58-
| Name | Description |
59-
| ------------------- | ------------------------------------------------------------------------------------------------------------------- |
60-
| `‑Name` | Optional. Name of the export. Supports wildcards. |
61-
| `‑Scope` | Optional. Resource ID of the scope the export was created for. If empty, defaults to current subscription context. |
62-
| `‑DataSet` | Optional. Dataset to get exports for. Allowed values = "ActualCost", "AmortizedCost". Default = null (all exports). |
63-
| `‑StorageAccountId` | Optional. Resource ID of the storage account to get exports for. Default = null (all exports). |
64-
| `‑StorageContainer` | Optional. Name of the container to get exports for. Supports wildcards. Default = null (all exports). |
65-
| `‑RunHistory` | Optional. Indicates whether the run history should be expanded. Default = false. |
66-
| `‑ApiVersion` | Optional. API version to use when calling the Cost Management exports API. Default = 2023-07-01-preview. |
67-
68-
<br>
69-
70-
## 📤 Return value
71-
72-
### FinOpsCostExport object
73-
74-
| Property | Type | JSON path |
75-
| --------------------- | ---------------------------- | ---------------------------------------------------------------------------- |
76-
| `Name` | String | `name` |
77-
| `Id` | String | `id` |
78-
| `Type` | String | `type` |
79-
| `eTag` | String | `eTag` |
80-
| `Description` | String | `properties.exportDescription` |
81-
| `Dataset` | String | `properties.definition.type` |
82-
| `DatasetVersion` | String | `properties.definition.configuration.dataVersion` |
83-
| `DatasetFilters` | String | `properties.definition.configuration.filter` |
84-
| `DatasetTimeFrame` | String | `properties.definition.timeframe` |
85-
| `DatasetStartDate` | DateTime | `properties.definition.timePeriod.from` |
86-
| `DatasetEndDate` | DateTime | `properties.definition.timePeriod.to` |
87-
| `DatasetGranularity` | String | `properties.definition.dataset.granularity` |
88-
| `ScheduleStatus` | String | `properties.schedule.status` |
89-
| `ScheduleRecurrence` | String | `properties.schedule.recurrence` |
90-
| `ScheduleStartDate` | DateTime | `properties.schedule.recurrencePeriod.from` |
91-
| `ScheduleEndDate` | DateTime | `properties.schedule.recurrencePeriod.to` |
92-
| `NextRuntimeEstimate` | DateTime | `properties.nextRunTimeEstimate` |
93-
| `Format` | String | `properties.format` |
94-
| `StorageAccountId` | String | `properties.deliveryInfo.destination.resourceId` |
95-
| `StorageContainer` | String | `properties.deliveryInfo.destination.container` |
96-
| `StoragePath` | String | `properties.deliveryInfo.destination.rootfolderpath` |
97-
| `OverwriteData` | Boolean | `properties.deliveryInfo.dataOverwriteBehavior` == "OverwritePreviousReport" |
98-
| `PartitionData` | Boolean | `properties.deliveryInfo.partitionData` |
99-
| `CompressionMode` | String | `properties.deliveryInfo.compressionMode` |
100-
| `RunHistory` | FinOpsCostExportRunHistory[] | `properties.runHistory.value` |
101-
102-
### FinOpsCostExportRunHistory object
103-
104-
| Property | Type | JSON path |
105-
| --------------- | -------- | -------------------------------------------------------- |
106-
| `Id` | String | `properties.runHistory.value[].id` |
107-
| `ExecutionType` | String | `properties.runHistory.value[].properties.executionType` |
108-
| `FileName` | String | `properties.runHistory.value[].fileName` |
109-
| `StartTime` | DateTime | `properties.runHistory.value[].processingStartTime` |
110-
| `EndTime` | DateTime | `properties.runHistory.value[].processingEndTime` |
111-
| `Status` | String | `properties.runHistory.value[].status` |
112-
| `SubmittedBy` | String | `properties.runHistory.value[].submittedBy` |
113-
| `SubmittedTime` | DateTime | `properties.runHistory.value[].submittedTime` |
59+
| Name | Description |
60+
| ---- | ----------- |
61+
| `‑Name` | Optional. Name of the export. Supports wildcards. |
62+
| `‑Scope` | Optional. Resource ID of the scope the export was created for. If empty, defaults to current subscription context. |
63+
| `‑Dataset` | Optional. Dataset to export. Allowed values = "ActualCost", "AmortizedCost", "FocusCost", "PriceSheet", "ReservationDetails", "ReservationTransactions", "ReservationRecommendations". Default = null (all exports). |
64+
| `‑DatasetVersion` | Optional. Schema version of the dataset to export. Default = null (all exports). |
65+
| `‑StorageAccountId` | Optional. Resource ID of the storage account to get exports for. Default = null (all exports). |
66+
| `‑StorageContainer` | Optional. Name of the container to get exports for. Supports wildcards. Default = null (all exports). |
67+
| `‑RunHistory` | Optional. Indicates whether the run history should be expanded. Default = false. |
68+
| `‑ApiVersion` | Optional. API version to use when calling the Cost Management exports API. Default = 2023-07-01-preview. |
11469

11570
<br>
11671

11772
## 🌟 Examples
11873

119-
### Get all cost exports for a subscription
74+
### Get cost exports for a subscription
12075

12176
```powershell
12277
Get-FinOpsCostExport `
@@ -133,28 +88,28 @@ Get-FinOpsCostExport `
13388
-Scope "providers/Microsoft.Billing/billingAccounts/00000000"
13489
```
13590

136-
Gets export with name matching wildcard mtd\* within the specified billing account scope. Does not include exports in nested resource groups.
91+
Gets export with name matching wildcard mtd* within the specified billing account scope. Does not include exports in nested resource groups.
13792

138-
### Get all amortized cost exports
93+
### Get amortized cost exports
13994

14095
```powershell
14196
Get-FinOpsCostExport `
142-
-DataSet "AmortizedCost"
97+
-Dataset "AmortizedCost"
14398
```
14499

145100
Gets all exports within the current context subscription scope and filtered by dataset AmortizedCost.
146101

147-
### Get exports using a specific storage account
102+
### Get exports using a storage account
148103

149104
```powershell
150105
Get-FinOpsCostExport `
151-
-Scope "/subscriptions/00000000-0000-0000-0000-000000000000"`
106+
-Scope "/subscriptions/00000000-0000-0000-0000-000000000000" `
152107
-StorageAccountId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Storage/storageAccounts/MyStorageAccount"
153108
```
154109

155110
Gets all exports within the subscription scope filtered by a specific storage account.
156111

157-
### Get exports using a specific container
112+
### Get exports using a storage container
158113

159114
```powershell
160115
Get-FinOpsCostExport `
@@ -164,23 +119,24 @@ Get-FinOpsCostExport `
164119

165120
Gets all exports within the subscription scope for a specific container. Supports wildcard.
166121

167-
### Get exports using a specific API version
122+
### Get exports using an API version
168123

169124
```powershell
170125
Get-FinOpsCostExport `
171-
-Scope "/subscriptions/00000000-0000-0000-0000-000000000000"
172-
-StorageContainer "mtd*"
173-
-ApiVersion "2023-08-01"
174-
-StorageContainer "MyContainer*"
126+
-Scope "/subscriptions/00000000-0000-0000-0000-000000000000" `
127+
-StorageContainer "mtd*" `
128+
-ApiVersion "2023-07-01-preview"
175129
```
176130

177131
Gets all exports within the subscription scope for a container matching wildcard pattern and using a specific API version.
132+
178133
<br>
179134

180135
---
181136

182137
## 🧰 Related tools
183138

184-
{% include tools.md hubs="1" pbi="1" %}
139+
{% include tools.md aoe="1" data="0" hubs="1" pbi="1" %}
185140

186141
<br>
142+

0 commit comments

Comments
 (0)