Skip to content

Commit

Permalink
CodeGen from PR 20243 in Azure/azure-rest-api-specs
Browse files Browse the repository at this point in the history
Merge 4770802427aa0fc55b75bb36023ffd747642b78e into 7547c9e15cd1d3ad655437aaffa9dda3bbc2a028
  • Loading branch information
SDKAuto committed Aug 17, 2022
1 parent 8616829 commit 6cdfc95
Show file tree
Hide file tree
Showing 30 changed files with 3,588 additions and 0 deletions.
1 change: 1 addition & 0 deletions swaggerci/agrifood/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto
16 changes: 16 additions & 0 deletions swaggerci/agrifood/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
bin
obj
.vs
generated
internal
exports
tools
custom/*.psm1
custom/autogen-model-cmdlets
test/*-TestResults.xml
/*.ps1
/*.ps1xml
/*.psm1
/*.snk
/*.csproj
/*.nuspec
24 changes: 24 additions & 0 deletions swaggerci/agrifood/Az.AgFoodPlatformRpService.psd1
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
@{
GUID = '970881ea-4ec9-475b-be39-37ce20db9f75'
RootModule = './Az.AgFoodPlatformRpService.psm1'
ModuleVersion = '0.1.0'
CompatiblePSEditions = 'Core', 'Desktop'
Author = 'Microsoft Corporation'
CompanyName = 'Microsoft Corporation'
Copyright = 'Microsoft Corporation. All rights reserved.'
Description = 'Microsoft Azure PowerShell: AgFoodPlatformRpService cmdlets'
PowerShellVersion = '5.1'
DotNetFrameworkVersion = '4.7.2'
RequiredAssemblies = './bin/Az.AgFoodPlatformRpService.private.dll'
FormatsToProcess = './Az.AgFoodPlatformRpService.format.ps1xml'
FunctionsToExport = 'Get-AzAgFoodPlatformRpServiceExtension', 'Get-AzAgFoodPlatformRpServiceFarmBeatModel', 'Get-AzAgFoodPlatformRpServiceFarmBeatModelOperationResult', 'Get-AzAgFoodPlatformRpServiceFarmBeatsExtension', 'Get-AzAgFoodPlatformRpServiceFarmBeatsModel', 'Get-AzAgFoodPlatformRpServicePrivateEndpointConnection', 'Get-AzAgFoodPlatformRpServicePrivateLinkResource', 'New-AzAgFoodPlatformRpServiceFarmBeatModel', 'New-AzAgFoodPlatformRpServicePrivateEndpointConnection', 'Remove-AzAgFoodPlatformRpServiceExtension', 'Remove-AzAgFoodPlatformRpServiceFarmBeatsModel', 'Remove-AzAgFoodPlatformRpServicePrivateEndpointConnection', 'Test-AzAgFoodPlatformRpServiceLocationNameAvailability', 'Update-AzAgFoodPlatformRpServiceFarmBeatsModel', '*'
AliasesToExport = '*'
PrivateData = @{
PSData = @{
Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'AgFoodPlatformRpService'
LicenseUri = 'https://aka.ms/azps-license'
ProjectUri = 'https://github.com/Azure/azure-powershell'
ReleaseNotes = ''
}
}
}
27 changes: 27 additions & 0 deletions swaggerci/agrifood/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!-- region Generated -->
# Az.AgFoodPlatformRpService
This directory contains the PowerShell module for the AgFoodPlatformRpService service.

---
## Status
[![Az.AgFoodPlatformRpService](https://img.shields.io/powershellgallery/v/Az.AgFoodPlatformRpService.svg?style=flat-square&label=Az.AgFoodPlatformRpService "Az.AgFoodPlatformRpService")](https://www.powershellgallery.com/packages/Az.AgFoodPlatformRpService/)

## Info
- Modifiable: yes
- Generated: all
- Committed: yes
- Packaged: yes

---
## Detail
This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension.

## Module Requirements
- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater

## Authentication
AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent.

## Development
For information on how to develop for `Az.AgFoodPlatformRpService`, see [how-to.md](how-to.md).
<!-- endregion -->
41 changes: 41 additions & 0 deletions swaggerci/agrifood/custom/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Custom
This directory contains custom implementation for non-generated cmdlets for the `Az.AgFoodPlatformRpService` 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.AgFoodPlatformRpService.custom.psm1`. This file should not be modified.

## Info
- Modifiable: yes
- Generated: partial
- Committed: yes
- Packaged: yes

## Details
For `Az.AgFoodPlatformRpService` 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*.

For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Az.AgFoodPlatformRpService.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.

For script cmdlets, these are loaded via the `Az.AgFoodPlatformRpService.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.

## Purpose
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.

## Usage
The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `../exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters:
- Break
- DefaultProfile
- HttpPipelineAppend
- HttpPipelinePrepend
- Proxy
- ProxyCredential
- ProxyUseDefaultCredentials

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.AgFoodPlatformRpService`. For C#, follow the usage seen in the `ProcessRecordAsync` method.

### Attributes
For processing the cmdlets, we've created some additional attributes:
- `Microsoft.Azure.PowerShell.Cmdlets.AgFoodPlatformRpService.DescriptionAttribute`
- Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts.
- `Microsoft.Azure.PowerShell.Cmdlets.AgFoodPlatformRpService.DoNotExportAttribute`
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.AgFoodPlatformRpService`.
- `Microsoft.Azure.PowerShell.Cmdlets.AgFoodPlatformRpService.InternalExportAttribute`
- Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.AgFoodPlatformRpService`. For more information, see [README.md](../internal/README.md) in the `../internal` folder.
- `Microsoft.Azure.PowerShell.Cmdlets.AgFoodPlatformRpService.ProfileAttribute`
- Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules.
55 changes: 55 additions & 0 deletions swaggerci/agrifood/docs/Az.AgFoodPlatformRpService.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
Module Name: Az.AgFoodPlatformRpService
Module Guid: 970881ea-4ec9-475b-be39-37ce20db9f75
Download Help Link: https://docs.microsoft.com/en-us/powershell/module/az.agfoodplatformrpservice
Help Version: 1.0.0.0
Locale: en-US
---

# Az.AgFoodPlatformRpService Module
## Description
Microsoft Azure PowerShell: AgFoodPlatformRpService cmdlets

## Az.AgFoodPlatformRpService Cmdlets
### [Get-AzAgFoodPlatformRpServiceExtension](Get-AzAgFoodPlatformRpServiceExtension.md)
Get installed extension details by extension id.

### [Get-AzAgFoodPlatformRpServiceFarmBeatModel](Get-AzAgFoodPlatformRpServiceFarmBeatModel.md)
Lists the FarmBeats instances for a subscription.

### [Get-AzAgFoodPlatformRpServiceFarmBeatModelOperationResult](Get-AzAgFoodPlatformRpServiceFarmBeatModelOperationResult.md)
Get operationResults for a FarmBeats resource.

### [Get-AzAgFoodPlatformRpServiceFarmBeatsExtension](Get-AzAgFoodPlatformRpServiceFarmBeatsExtension.md)
Get farmBeats extension.

### [Get-AzAgFoodPlatformRpServiceFarmBeatsModel](Get-AzAgFoodPlatformRpServiceFarmBeatsModel.md)
Get FarmBeats resource.

### [Get-AzAgFoodPlatformRpServicePrivateEndpointConnection](Get-AzAgFoodPlatformRpServicePrivateEndpointConnection.md)
Get Private endpoint connection object.

### [Get-AzAgFoodPlatformRpServicePrivateLinkResource](Get-AzAgFoodPlatformRpServicePrivateLinkResource.md)
Get Private link resource object.

### [New-AzAgFoodPlatformRpServiceFarmBeatModel](New-AzAgFoodPlatformRpServiceFarmBeatModel.md)
Create or update FarmBeats resource.

### [New-AzAgFoodPlatformRpServicePrivateEndpointConnection](New-AzAgFoodPlatformRpServicePrivateEndpointConnection.md)
Approves or Rejects a Private endpoint connection request.

### [Remove-AzAgFoodPlatformRpServiceExtension](Remove-AzAgFoodPlatformRpServiceExtension.md)
Uninstall extension.

### [Remove-AzAgFoodPlatformRpServiceFarmBeatsModel](Remove-AzAgFoodPlatformRpServiceFarmBeatsModel.md)
Delete a FarmBeats resource.

### [Remove-AzAgFoodPlatformRpServicePrivateEndpointConnection](Remove-AzAgFoodPlatformRpServicePrivateEndpointConnection.md)
Delete Private endpoint connection request.

### [Test-AzAgFoodPlatformRpServiceLocationNameAvailability](Test-AzAgFoodPlatformRpServiceLocationNameAvailability.md)
Checks the name availability of the resource with requested resource name.

### [Update-AzAgFoodPlatformRpServiceFarmBeatsModel](Update-AzAgFoodPlatformRpServiceFarmBeatsModel.md)
Update a FarmBeats resource.

Loading

0 comments on commit 6cdfc95

Please sign in to comment.