You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Tsp - Fixed an enum related issue
* Delete tests-upgrade/tests-emitter/EdgeZones.Management/target/custom/Az.DeviceRegistry.custom.psm1
Remove an unused file
Copy file name to clipboardExpand all lines: tests-upgrade/tests-emitter/EdgeZones.Management/target/README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
<!-- region Generated -->
2
-
# Az.DeviceRegistry
3
-
This directory contains the PowerShell module for the DeviceRegistry service.
2
+
# Az.EdgeZones
3
+
This directory contains the PowerShell module for the EdgeZones service.
4
4
5
5
---
6
6
## Info
@@ -20,5 +20,5 @@ This module was primarily generated via [AutoRest](https://github.com/Azure/auto
20
20
AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent.
21
21
22
22
## Development
23
-
For information on how to develop for `Az.DeviceRegistry`, see [how-to.md](how-to.md).
23
+
For information on how to develop for `Az.EdgeZones`, see [how-to.md](how-to.md).
This directory contains custom implementation for non-generated cmdlets for the `Az.DeviceRegistry` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `..\exports` folder. The only generated file into this folder is the `Az.DeviceRegistry.custom.psm1`. This file should not be modified.
2
+
This directory contains custom implementation for non-generated cmdlets for the `Az.EdgeZones` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `..\exports` folder. The only generated file into this folder is the `Az.EdgeZones.custom.psm1`. This file should not be modified.
3
3
4
4
## Info
5
5
- Modifiable: yes
@@ -8,11 +8,11 @@ This directory contains custom implementation for non-generated cmdlets for the
8
8
- Packaged: yes
9
9
10
10
## Details
11
-
For `Az.DeviceRegistry` to use custom cmdlets, it does this two different ways. We **highly recommend** creating script cmdlets, as they are easier to write and allow access to the other exported cmdlets. C# cmdlets *cannot access exported cmdlets*.
11
+
For `Az.EdgeZones` to use custom cmdlets, it does this two different ways. We **highly recommend** creating script cmdlets, as they are easier to write and allow access to the other exported cmdlets. C# cmdlets *cannot access exported cmdlets*.
12
12
13
-
For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Az.DeviceRegistry.private.dll`. The names of the cmdlets (methods) and files must follow the `[cmdletName]_[variantName]` syntax used for generated cmdlets. The `variantName` is used as the `ParameterSetName`, so use something appropriate that doesn't clash with already created variant or parameter set names. You cannot use the `ParameterSetName` property in the `Parameter` attribute on C# cmdlets. Each cmdlet must be separated into variants using the same pattern as seen in the `generated/cmdlets` folder.
13
+
For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Az.EdgeZones.private.dll`. The names of the cmdlets (methods) and files must follow the `[cmdletName]_[variantName]` syntax used for generated cmdlets. The `variantName` is used as the `ParameterSetName`, so use something appropriate that doesn't clash with already created variant or parameter set names. You cannot use the `ParameterSetName` property in the `Parameter` attribute on C# cmdlets. Each cmdlet must be separated into variants using the same pattern as seen in the `generated/cmdlets` folder.
14
14
15
-
For script cmdlets, these are loaded via the `Az.DeviceRegistry.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build.
15
+
For script cmdlets, these are loaded via the `Az.EdgeZones.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build.
16
16
17
17
## Purpose
18
18
This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `..\exports` folder.
@@ -27,15 +27,15 @@ The easiest way currently to start developing custom cmdlets is to copy an exist
27
27
- ProxyCredential
28
28
- ProxyUseDefaultCredentials
29
29
30
-
These provide functionality to our HTTP pipeline and other useful features. In script, you can forward these parameters using `$PSBoundParameters` to the other cmdlets you're calling within `Az.DeviceRegistry`. For C#, follow the usage seen in the `ProcessRecordAsync` method.
30
+
These provide functionality to our HTTP pipeline and other useful features. In script, you can forward these parameters using `$PSBoundParameters` to the other cmdlets you're calling within `Az.EdgeZones`. For C#, follow the usage seen in the `ProcessRecordAsync` method.
31
31
32
32
### Attributes
33
33
For processing the cmdlets, we've created some additional attributes:
- Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts.
- Used in C# cmdlets to route exported cmdlets to the `..\internal`, which are *not exposed* by `Az.DeviceRegistry`. For more information, see [README.md](..\internal/README.md) in the `..\internal` folder.
- Used in C# cmdlets to route exported cmdlets to the `..\internal`, which are *not exposed* by `Az.EdgeZones`. For more information, see [README.md](..\internal/README.md) in the `..\internal` folder.
This directory contains the documentation of the cmdlets for the `Az.DeviceRegistry` 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.
2
+
This directory contains the documentation of the cmdlets for the `Az.EdgeZones` 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.
3
3
4
4
## Info
5
5
- Modifiable: no
@@ -8,4 +8,4 @@ This directory contains the documentation of the cmdlets for the `Az.DeviceRegis
8
8
- Packaged: yes
9
9
10
10
## Details
11
-
The process of documentation generation loads `Az.DeviceRegistry` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.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.
11
+
The process of documentation generation loads `Az.EdgeZones` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.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.
0 commit comments