Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ReleasePR Az.streamanalytics] [Hub Generated] Review request for Microsoft.StreamAnalytics to add version preview/2021-10-01-preview #18545

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions swaggerci/streamanalytics/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto
16 changes: 16 additions & 0 deletions swaggerci/streamanalytics/.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/streamanalytics/Az.StreamAnalytics.psd1
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
@{
GUID = '40504018-542b-408a-8ecd-ab6d6cd4dc6f'
RootModule = './Az.StreamAnalytics.psm1'
ModuleVersion = '0.1.0'
CompatiblePSEditions = 'Core', 'Desktop'
Author = 'Microsoft Corporation'
CompanyName = 'Microsoft Corporation'
Copyright = 'Microsoft Corporation. All rights reserved.'
Description = 'Microsoft Azure PowerShell: StreamAnalytics cmdlets'
PowerShellVersion = '5.1'
DotNetFrameworkVersion = '4.7.2'
RequiredAssemblies = './bin/Az.StreamAnalytics.private.dll'
FormatsToProcess = './Az.StreamAnalytics.format.ps1xml'
FunctionsToExport = 'Get-AzStreamAnalyticsCluster', 'Get-AzStreamAnalyticsClusterStreamingJob', 'Get-AzStreamAnalyticsFunction', 'Get-AzStreamAnalyticsFunctionDefaultDefinition', 'Get-AzStreamAnalyticsInput', 'Get-AzStreamAnalyticsOutput', 'Get-AzStreamAnalyticsPrivateEndpoint', 'Get-AzStreamAnalyticsStreamingJob', 'Get-AzStreamAnalyticsSubscriptionQuota', 'Get-AzStreamAnalyticsTransformation', 'Invoke-AzStreamAnalyticsScaleStreamingJob', 'New-AzStreamAnalyticsCluster', 'New-AzStreamAnalyticsFunction', 'New-AzStreamAnalyticsInput', 'New-AzStreamAnalyticsOutput', 'New-AzStreamAnalyticsPrivateEndpoint', 'New-AzStreamAnalyticsStreamingJob', 'New-AzStreamAnalyticsTransformation', 'Remove-AzStreamAnalyticsCluster', 'Remove-AzStreamAnalyticsFunction', 'Remove-AzStreamAnalyticsInput', 'Remove-AzStreamAnalyticsOutput', 'Remove-AzStreamAnalyticsPrivateEndpoint', 'Remove-AzStreamAnalyticsStreamingJob', 'Start-AzStreamAnalyticsStreamingJob', 'Stop-AzStreamAnalyticsStreamingJob', 'Test-AzStreamAnalyticsFunction', 'Test-AzStreamAnalyticsInput', 'Test-AzStreamAnalyticsOutput', 'Update-AzStreamAnalyticsCluster', 'Update-AzStreamAnalyticsFunction', 'Update-AzStreamAnalyticsInput', 'Update-AzStreamAnalyticsOutput', 'Update-AzStreamAnalyticsStreamingJob', 'Update-AzStreamAnalyticsTransformation', '*'
AliasesToExport = '*'
PrivateData = @{
PSData = @{
Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'StreamAnalytics'
LicenseUri = 'https://aka.ms/azps-license'
ProjectUri = 'https://github.com/Azure/azure-powershell'
ReleaseNotes = ''
}
}
}
27 changes: 27 additions & 0 deletions swaggerci/streamanalytics/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!-- region Generated -->
# Az.StreamAnalytics
This directory contains the PowerShell module for the StreamAnalytics service.

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

## 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.StreamAnalytics`, see [how-to.md](how-to.md).
<!-- endregion -->
41 changes: 41 additions & 0 deletions swaggerci/streamanalytics/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.StreamAnalytics` 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.StreamAnalytics.custom.psm1`. This file should not be modified.

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

## Details
For `Az.StreamAnalytics` 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.StreamAnalytics.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.StreamAnalytics.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.StreamAnalytics`. 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.StreamAnalytics.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.StreamAnalytics.DoNotExportAttribute`
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.StreamAnalytics`.
- `Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.InternalExportAttribute`
- Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.StreamAnalytics`. For more information, see [README.md](../internal/README.md) in the `../internal` folder.
- `Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.ProfileAttribute`
- Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules.
133 changes: 133 additions & 0 deletions swaggerci/streamanalytics/docs/Az.StreamAnalytics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
---
Module Name: Az.StreamAnalytics
Module Guid: 40504018-542b-408a-8ecd-ab6d6cd4dc6f
Download Help Link: https://docs.microsoft.com/en-us/powershell/module/az.streamanalytics
Help Version: 1.0.0.0
Locale: en-US
---

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

## Az.StreamAnalytics Cmdlets
### [Get-AzStreamAnalyticsCluster](Get-AzStreamAnalyticsCluster.md)
Gets information about the specified cluster.

### [Get-AzStreamAnalyticsClusterStreamingJob](Get-AzStreamAnalyticsClusterStreamingJob.md)
Lists all of the streaming jobs in the given cluster.

### [Get-AzStreamAnalyticsFunction](Get-AzStreamAnalyticsFunction.md)
Gets details about the specified function.

### [Get-AzStreamAnalyticsFunctionDefaultDefinition](Get-AzStreamAnalyticsFunctionDefaultDefinition.md)
Retrieves the default definition of a function based on the parameters specified.

### [Get-AzStreamAnalyticsInput](Get-AzStreamAnalyticsInput.md)
Gets details about the specified input.

### [Get-AzStreamAnalyticsOutput](Get-AzStreamAnalyticsOutput.md)
Gets details about the specified output.

### [Get-AzStreamAnalyticsPrivateEndpoint](Get-AzStreamAnalyticsPrivateEndpoint.md)
Gets information about the specified Private Endpoint.

### [Get-AzStreamAnalyticsStreamingJob](Get-AzStreamAnalyticsStreamingJob.md)
Gets details about the specified streaming job.

### [Get-AzStreamAnalyticsSubscriptionQuota](Get-AzStreamAnalyticsSubscriptionQuota.md)
Retrieves the subscription's current quota information in a particular region.

### [Get-AzStreamAnalyticsTransformation](Get-AzStreamAnalyticsTransformation.md)
Gets details about the specified transformation.

### [Invoke-AzStreamAnalyticsScaleStreamingJob](Invoke-AzStreamAnalyticsScaleStreamingJob.md)
Scales a streaming job when the job is running.

### [New-AzStreamAnalyticsCluster](New-AzStreamAnalyticsCluster.md)
Creates a Stream Analytics Cluster or replaces an already existing cluster.

### [New-AzStreamAnalyticsFunction](New-AzStreamAnalyticsFunction.md)
Creates a function or replaces an already existing function under an existing streaming job.

### [New-AzStreamAnalyticsInput](New-AzStreamAnalyticsInput.md)
Creates an input or replaces an already existing input under an existing streaming job.

### [New-AzStreamAnalyticsOutput](New-AzStreamAnalyticsOutput.md)
Creates an output or replaces an already existing output under an existing streaming job.

### [New-AzStreamAnalyticsPrivateEndpoint](New-AzStreamAnalyticsPrivateEndpoint.md)
Creates a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.

### [New-AzStreamAnalyticsStreamingJob](New-AzStreamAnalyticsStreamingJob.md)
Creates a streaming job or replaces an already existing streaming job.

### [New-AzStreamAnalyticsTransformation](New-AzStreamAnalyticsTransformation.md)
Creates a transformation or replaces an already existing transformation under an existing streaming job.

### [Remove-AzStreamAnalyticsCluster](Remove-AzStreamAnalyticsCluster.md)
Deletes the specified cluster.

### [Remove-AzStreamAnalyticsFunction](Remove-AzStreamAnalyticsFunction.md)
Deletes a function from the streaming job.

### [Remove-AzStreamAnalyticsInput](Remove-AzStreamAnalyticsInput.md)
Deletes an input from the streaming job.

### [Remove-AzStreamAnalyticsOutput](Remove-AzStreamAnalyticsOutput.md)
Deletes an output from the streaming job.

### [Remove-AzStreamAnalyticsPrivateEndpoint](Remove-AzStreamAnalyticsPrivateEndpoint.md)
Delete the specified private endpoint.

### [Remove-AzStreamAnalyticsStreamingJob](Remove-AzStreamAnalyticsStreamingJob.md)
Deletes a streaming job.

### [Start-AzStreamAnalyticsStreamingJob](Start-AzStreamAnalyticsStreamingJob.md)
Starts a streaming job.
Once a job is started it will start processing input events and produce output.

### [Stop-AzStreamAnalyticsStreamingJob](Stop-AzStreamAnalyticsStreamingJob.md)
Stops a running streaming job.
This will cause a running streaming job to stop processing input events and producing output.

### [Test-AzStreamAnalyticsFunction](Test-AzStreamAnalyticsFunction.md)
Tests if the information provided for a function is valid.
This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct.

### [Test-AzStreamAnalyticsInput](Test-AzStreamAnalyticsInput.md)
Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.

### [Test-AzStreamAnalyticsOutput](Test-AzStreamAnalyticsOutput.md)
Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.

### [Update-AzStreamAnalyticsCluster](Update-AzStreamAnalyticsCluster.md)
Updates an existing cluster.
This can be used to partially update (ie.
update one or two properties) a cluster without affecting the rest of the cluster definition.

### [Update-AzStreamAnalyticsFunction](Update-AzStreamAnalyticsFunction.md)
Updates an existing function under an existing streaming job.
This can be used to partially update (ie.
update one or two properties) a function without affecting the rest the job or function definition.

### [Update-AzStreamAnalyticsInput](Update-AzStreamAnalyticsInput.md)
Updates an existing input under an existing streaming job.
This can be used to partially update (ie.
update one or two properties) an input without affecting the rest the job or input definition.

### [Update-AzStreamAnalyticsOutput](Update-AzStreamAnalyticsOutput.md)
Updates an existing output under an existing streaming job.
This can be used to partially update (ie.
update one or two properties) an output without affecting the rest the job or output definition.

### [Update-AzStreamAnalyticsStreamingJob](Update-AzStreamAnalyticsStreamingJob.md)
Updates an existing streaming job.
This can be used to partially update (ie.
update one or two properties) a streaming job without affecting the rest the job definition.

### [Update-AzStreamAnalyticsTransformation](Update-AzStreamAnalyticsTransformation.md)
Updates an existing transformation under an existing streaming job.
This can be used to partially update (ie.
update one or two properties) a transformation without affecting the rest the job or transformation definition.

Loading