Skip to content

Commit e987cfb

Browse files
committed
add directive to readme.md to remove the option to set SearchLogs and RestoredLogs in new and update "Table" resource
re ran autorest - no additional files created
1 parent 46542d2 commit e987cfb

File tree

3 files changed

+21
-55
lines changed

3 files changed

+21
-55
lines changed

src/OperationalInsights/OperationalInsights.Autorest/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ directive:
6565
2000,
6666
5000
6767
]
68-
}
68+
}
6969
# Following is two common directive which are normally required in all the RPs
7070
# 1. Remove the unexpanded parameter set
7171
# 2. For New-* cmdlets, ViaIdentity is not required, so CreateViaIdentityExpanded is removed as well
@@ -83,7 +83,19 @@ directive:
8383
parameter-name: SkuName
8484
set:
8585
parameter-name: Sku
86-
86+
87+
- where:
88+
verb: New|Update
89+
subject: Table
90+
parameter-name: RestoredLogs
91+
hide: true
92+
93+
- where:
94+
verb: New|Update
95+
subject: Table
96+
parameter-name: SearchResults
97+
hide: true
98+
8799
- where:
88100
verb: New|Update
89101
subject: Workspace

src/OperationalInsights/OperationalInsights.Autorest/examples/Az.OperationalInsights.md

Lines changed: 0 additions & 46 deletions
This file was deleted.
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Docs
2-
This directory contains the documentation of the cmdlets for the `Az.OperationalInsights` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `../examples` folder.
1+
# Examples
2+
This directory contains examples from the exported cmdlets of the module. When `build-module.ps1` is ran, example stub files will be generated here. If your module support Azure Profiles, the example stubs will be in individual profile folders. These example stubs should be updated to show how the cmdlet is used. The examples are imported into the documentation when `generate-help.ps1` is ran.
33

44
## Info
5-
- Modifiable: no
6-
- Generated: all
5+
- Modifiable: yes
6+
- Generated: partial
77
- Committed: yes
8-
- Packaged: yes
8+
- Packaged: no
99

10-
## Details
11-
The process of documentation generation loads `Az.OperationalInsights` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder.
10+
## Purpose
11+
This separates the example documentation details from the generated documentation information provided directly from the generated cmdlets. Since the cmdlets don't have examples from the REST spec, this provides a means to add examples easily. The example stubs provide the markdown format that is required. The 3 core elements are: the name of the example, the code information of the example, and the description of the example. That information, if the markdown format is followed, will be available to documentation generation and be part of the documents in the `../docs` folder.

0 commit comments

Comments
 (0)