Skip to content

Commit 0f8cf1d

Browse files
author
SDKAuto
committed
CodeGen from PR 29938 in Azure/azure-rest-api-specs
Merge cff8233bd23398a224c5d7bb9a0e5c60b72e7c66 into 3c4ddfa53535e9e2b775d885d91aa1ab57a7a7fd
1 parent 773a148 commit 0f8cf1d

File tree

52 files changed

+9833
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+9833
-0
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
bin
2+
obj
3+
.vs
4+
generated
5+
internal
6+
exports
7+
tools
8+
custom/*.psm1
9+
custom/autogen-model-cmdlets
10+
test/*-TestResults.xml
11+
/*.ps1
12+
/*.ps1xml
13+
/*.psm1
14+
/*.snk
15+
/*.csproj
16+
/*.nuspec
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
@{
2+
GUID = '8091372c-3085-4575-a624-c3ab46f93e63'
3+
RootModule = './Az.StreamAnalytics.psm1'
4+
ModuleVersion = '0.1.0'
5+
CompatiblePSEditions = 'Core', 'Desktop'
6+
Author = 'Microsoft Corporation'
7+
CompanyName = 'Microsoft Corporation'
8+
Copyright = 'Microsoft Corporation. All rights reserved.'
9+
Description = 'Microsoft Azure PowerShell: StreamAnalytics cmdlets'
10+
PowerShellVersion = '5.1'
11+
DotNetFrameworkVersion = '4.7.2'
12+
RequiredAssemblies = './bin/Az.StreamAnalytics.private.dll'
13+
FormatsToProcess = './Az.StreamAnalytics.format.ps1xml'
14+
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', '*'
15+
AliasesToExport = '*'
16+
PrivateData = @{
17+
PSData = @{
18+
Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'StreamAnalytics'
19+
LicenseUri = 'https://aka.ms/azps-license'
20+
ProjectUri = 'https://github.com/Azure/azure-powershell'
21+
ReleaseNotes = ''
22+
}
23+
}
24+
}
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- region Generated -->
2+
# Az.StreamAnalytics
3+
This directory contains the PowerShell module for the StreamAnalytics service.
4+
5+
---
6+
## Info
7+
- Modifiable: yes
8+
- Generated: all
9+
- Committed: yes
10+
- Packaged: yes
11+
12+
---
13+
## Detail
14+
This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension.
15+
16+
## Module Requirements
17+
- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater
18+
19+
## Authentication
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+
22+
## Development
23+
For information on how to develop for `Az.StreamAnalytics`, see [how-to.md](how-to.md).
24+
<!-- endregion -->
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Custom
2+
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.
3+
4+
## Info
5+
- Modifiable: yes
6+
- Generated: partial
7+
- Committed: yes
8+
- Packaged: yes
9+
10+
## Details
11+
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*.
12+
13+
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.
14+
15+
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.
16+
17+
## Purpose
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.
19+
20+
## Usage
21+
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:
22+
- Break
23+
- DefaultProfile
24+
- HttpPipelineAppend
25+
- HttpPipelinePrepend
26+
- Proxy
27+
- ProxyCredential
28+
- ProxyUseDefaultCredentials
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.StreamAnalytics`. For C#, follow the usage seen in the `ProcessRecordAsync` method.
31+
32+
### Attributes
33+
For processing the cmdlets, we've created some additional attributes:
34+
- `Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.DescriptionAttribute`
35+
- 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.
36+
- `Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.DoNotExportAttribute`
37+
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.StreamAnalytics`.
38+
- `Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.InternalExportAttribute`
39+
- 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.
40+
- `Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.ProfileAttribute`
41+
- Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules.
Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
---
2+
Module Name: Az.StreamAnalytics
3+
Module Guid: 8091372c-3085-4575-a624-c3ab46f93e63
4+
Download Help Link: https://learn.microsoft.com/powershell/module/az.streamanalytics
5+
Help Version: 1.0.0.0
6+
Locale: en-US
7+
---
8+
9+
# Az.StreamAnalytics Module
10+
## Description
11+
Microsoft Azure PowerShell: StreamAnalytics cmdlets
12+
13+
## Az.StreamAnalytics Cmdlets
14+
### [Get-AzStreamAnalyticsCluster](Get-AzStreamAnalyticsCluster.md)
15+
Gets information about the specified cluster.
16+
17+
### [Get-AzStreamAnalyticsClusterStreamingJob](Get-AzStreamAnalyticsClusterStreamingJob.md)
18+
Lists all of the streaming jobs in the given cluster.
19+
20+
### [Get-AzStreamAnalyticsFunction](Get-AzStreamAnalyticsFunction.md)
21+
Gets details about the specified function.
22+
23+
### [Get-AzStreamAnalyticsFunctionDefaultDefinition](Get-AzStreamAnalyticsFunctionDefaultDefinition.md)
24+
Retrieves the default definition of a function based on the parameters specified.
25+
26+
### [Get-AzStreamAnalyticsInput](Get-AzStreamAnalyticsInput.md)
27+
Gets details about the specified input.
28+
29+
### [Get-AzStreamAnalyticsOutput](Get-AzStreamAnalyticsOutput.md)
30+
Gets details about the specified output.
31+
32+
### [Get-AzStreamAnalyticsPrivateEndpoint](Get-AzStreamAnalyticsPrivateEndpoint.md)
33+
Gets information about the specified Private Endpoint.
34+
35+
### [Get-AzStreamAnalyticsStreamingJob](Get-AzStreamAnalyticsStreamingJob.md)
36+
Gets details about the specified streaming job.
37+
38+
### [Get-AzStreamAnalyticsSubscriptionQuota](Get-AzStreamAnalyticsSubscriptionQuota.md)
39+
Retrieves the subscription's current quota information in a particular region.
40+
41+
### [Get-AzStreamAnalyticsTransformation](Get-AzStreamAnalyticsTransformation.md)
42+
Gets details about the specified transformation.
43+
44+
### [Invoke-AzStreamAnalyticsScaleStreamingJob](Invoke-AzStreamAnalyticsScaleStreamingJob.md)
45+
Scales a streaming job when the job is running.
46+
47+
### [New-AzStreamAnalyticsCluster](New-AzStreamAnalyticsCluster.md)
48+
Creates a Stream Analytics Cluster or replaces an already existing cluster.
49+
50+
### [New-AzStreamAnalyticsFunction](New-AzStreamAnalyticsFunction.md)
51+
Creates a function or replaces an already existing function under an existing streaming job.
52+
53+
### [New-AzStreamAnalyticsInput](New-AzStreamAnalyticsInput.md)
54+
Creates an input or replaces an already existing input under an existing streaming job.
55+
56+
### [New-AzStreamAnalyticsOutput](New-AzStreamAnalyticsOutput.md)
57+
Creates an output or replaces an already existing output under an existing streaming job.
58+
59+
### [New-AzStreamAnalyticsPrivateEndpoint](New-AzStreamAnalyticsPrivateEndpoint.md)
60+
Creates a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.
61+
62+
### [New-AzStreamAnalyticsStreamingJob](New-AzStreamAnalyticsStreamingJob.md)
63+
Creates a streaming job or replaces an already existing streaming job.
64+
65+
### [New-AzStreamAnalyticsTransformation](New-AzStreamAnalyticsTransformation.md)
66+
Creates a transformation or replaces an already existing transformation under an existing streaming job.
67+
68+
### [Remove-AzStreamAnalyticsCluster](Remove-AzStreamAnalyticsCluster.md)
69+
Deletes the specified cluster.
70+
71+
### [Remove-AzStreamAnalyticsFunction](Remove-AzStreamAnalyticsFunction.md)
72+
Deletes a function from the streaming job.
73+
74+
### [Remove-AzStreamAnalyticsInput](Remove-AzStreamAnalyticsInput.md)
75+
Deletes an input from the streaming job.
76+
77+
### [Remove-AzStreamAnalyticsOutput](Remove-AzStreamAnalyticsOutput.md)
78+
Deletes an output from the streaming job.
79+
80+
### [Remove-AzStreamAnalyticsPrivateEndpoint](Remove-AzStreamAnalyticsPrivateEndpoint.md)
81+
Delete the specified private endpoint.
82+
83+
### [Remove-AzStreamAnalyticsStreamingJob](Remove-AzStreamAnalyticsStreamingJob.md)
84+
Deletes a streaming job.
85+
86+
### [Start-AzStreamAnalyticsStreamingJob](Start-AzStreamAnalyticsStreamingJob.md)
87+
Starts a streaming job.
88+
Once a job is started it will start processing input events and produce output.
89+
90+
### [Stop-AzStreamAnalyticsStreamingJob](Stop-AzStreamAnalyticsStreamingJob.md)
91+
Stops a running streaming job.
92+
This will cause a running streaming job to stop processing input events and producing output.
93+
94+
### [Test-AzStreamAnalyticsFunction](Test-AzStreamAnalyticsFunction.md)
95+
Tests if the information provided for a function is valid.
96+
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.
97+
98+
### [Test-AzStreamAnalyticsInput](Test-AzStreamAnalyticsInput.md)
99+
Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.
100+
101+
### [Test-AzStreamAnalyticsOutput](Test-AzStreamAnalyticsOutput.md)
102+
Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.
103+
104+
### [Update-AzStreamAnalyticsCluster](Update-AzStreamAnalyticsCluster.md)
105+
Updates an existing cluster.
106+
This can be used to partially update (ie.
107+
update one or two properties) a cluster without affecting the rest of the cluster definition.
108+
109+
### [Update-AzStreamAnalyticsFunction](Update-AzStreamAnalyticsFunction.md)
110+
Updates an existing function under an existing streaming job.
111+
This can be used to partially update (ie.
112+
update one or two properties) a function without affecting the rest the job or function definition.
113+
114+
### [Update-AzStreamAnalyticsInput](Update-AzStreamAnalyticsInput.md)
115+
Updates an existing input under an existing streaming job.
116+
This can be used to partially update (ie.
117+
update one or two properties) an input without affecting the rest the job or input definition.
118+
119+
### [Update-AzStreamAnalyticsOutput](Update-AzStreamAnalyticsOutput.md)
120+
Updates an existing output under an existing streaming job.
121+
This can be used to partially update (ie.
122+
update one or two properties) an output without affecting the rest the job or output definition.
123+
124+
### [Update-AzStreamAnalyticsStreamingJob](Update-AzStreamAnalyticsStreamingJob.md)
125+
Updates an existing streaming job.
126+
This can be used to partially update (ie.
127+
update one or two properties) a streaming job without affecting the rest the job definition.
128+
129+
### [Update-AzStreamAnalyticsTransformation](Update-AzStreamAnalyticsTransformation.md)
130+
Updates an existing transformation under an existing streaming job.
131+
This can be used to partially update (ie.
132+
update one or two properties) a transformation without affecting the rest the job or transformation definition.
133+

0 commit comments

Comments
 (0)