Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 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: 0 additions & 1 deletion src/Nginx/Nginx.Autorest/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,3 @@
[assembly: System.Reflection.AssemblyVersionAttribute("1.2.0")]
[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
[assembly: System.CLSCompliantAttribute(false)]

84 changes: 5 additions & 79 deletions src/Nginx/Nginx.Autorest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,22 +38,13 @@ root-module-name: $(prefix).Nginx
title: Nginx
module-version: 0.1.0
subject-prefix: Nginx
nested-object-to-string: true

# If there are post APIs for some kinds of actions in the RP, you may need to
# uncomment following line to support viaIdentity for these post APIs
# identity-correction-for-post: true

# For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option
use-extension:
"@autorest/powershell": "3.x"

directive:
# Following is two common directive which are normally required in all the RPs
# 1. Remove the unexpanded parameter set
# 2. For New-* cmdlets, ViaIdentity is not required, so CreateViaIdentityExpanded is removed as well
- where:
variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$
variant: ^(Create|Update|Analysis)(?!.*?(Expanded|JsonFilePath|JsonString))|^CreateViaIdentityExpanded$
remove: true
- where:
subject: Configuration|Certificate|Deployment
Expand Down Expand Up @@ -234,75 +225,10 @@ directive:
]
}
- model-cmdlet:
- NginxConfigurationFile
- NginxPrivateIPAddress
- NginxPublicIPAddress
# - NginxNetworkProfile
- model-name: NginxConfigurationFile
- model-name: NginxPrivateIPAddress
- model-name: NginxPublicIPAddress
- model-name: NginxNetworkProfile
- no-inline:
- NginxNetworkProfile
- where:
verb: Get|Update|New
subject: Configuration
set:
breaking-change:
deprecated-output-properties:
- File
- ProtectedFile
- PackageProtectedFile
new-output-properties:
- File
- ProtectedFile
- PackageProtectedFile
change-description: The types of the properties File, ProtectedFile and PackageProtectedFile will be changed from fixed array to 'List'.
deprecated-by-version: 2.0.0
deprecated-by-azversion: 15.0.0
change-effective-date: 2025/11/03
- where:
verb: Get|Update|New
subject: Deployment
set:
breaking-change:
deprecated-output-properties:
- PrivateIPAddress
- PublicIPAddress
- AutoScaleSettingProfile
new-output-properties:
- PrivateIPAddress
- PublicIPAddress
- AutoScaleSettingProfile
change-description: The types of the properties PrivateIPAddress, ProtectedFile and AutoScaleSettingProfile will be changed from fixed array to 'List'.
deprecated-by-version: 2.0.0
deprecated-by-azversion: 15.0.0
change-effective-date: 2025/11/03
- where:
verb: Invoke
subject: AnalysisConfiguration
set:
breaking-change:
deprecated-output-properties:
- DataError
new-output-properties:
- DataError
change-description: The type of the property DataError will be changed from fixed array to 'List'.
deprecated-by-version: 7.0.0
deprecated-by-azversion: 15.0.0
change-effective-date: 2025/11/03
- where:
verb: Invoke
subject: AnalysisConfiguration
variant: ^Analysis$|^AnalysisViaIdentity$
set:
breaking-change:
change-description: The parameter set 'Analysis' and 'AnalysisViaIdentity' will be removed.
deprecated-by-version: 7.0.0
deprecated-by-azversion: 15.0.0
change-effective-date: 2025/11/03
- where:
parameter-name: IdentityType|IdentityUserAssignedIdentity
set:
breaking-change:
change-description: The cmdlet 'New-AzNginxDeployment' no longer supports the parameter 'IdentityType' and IdentityUserAssignedIdentity.
deprecated-by-version: 2.0.0
deprecated-by-azversion: 15.0.0
change-effective-date: 2025/11/03
```
Original file line number Diff line number Diff line change
Expand Up @@ -48,49 +48,6 @@
}
]
},
{
"name": "Invoke-AzNginxAnalysisConfiguration",
"description": "Analyze an NGINX configuration without applying it to the NGINXaaS deployment",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}/analyze",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.nginx/invoke-aznginxanalysisconfiguration"
},
"parameterSets": [
{
"parameters": [
"-ConfigurationName <String>",
"-DeploymentName <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String>]"
]
}
]
},
"examples": [
{
"description": "Analyze an NGINX configuration without applying it to the NGINXaaS deployment",
"parameters": [
{
"name": "-ConfigurationName",
"value": "[Path.configurationName]"
},
{
"name": "-DeploymentName",
"value": "[Path.deploymentName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
},
{
"name": "Remove-AzNginxConfiguration",
"description": "Reset the NGINX configuration of given NGINX deployment to default",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,26 @@ Create an in-memory object for NginxNetworkProfile.
Create an in-memory object for NginxNetworkProfile.

.Outputs
Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.NginxNetworkProfile
Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.NginxNetworkProfile
.Link
https://learn.microsoft.com/powershell/module/Az.Nginx/new-AzNginxNetworkProfileObject
https://learn.microsoft.com/powershell/module/Az.Nginx/new-aznginxnetworkprofileobject
#>
function New-AzNginxNetworkProfileObject {
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.NginxNetworkProfile')]
[Microsoft.Azure.PowerShell.Cmdlets.Nginx.Runtime.OutputBreakingChange("Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.NginxNetworkProfile", "15.0.0", "2.0.0", "2025/11/03", ChangeDescription = "The types of the properties PrivateIPAddress and PublicIPAddress of Property FrontendIPConfiguration will be changed from fixed array to 'List'.")]
[Microsoft.Azure.PowerShell.Cmdlets.Nginx.ModelCmdletAttribute()]
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.NginxNetworkProfile')]
[CmdletBinding(PositionalBinding=$false)]
Param(

[Parameter()]
[Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.INginxFrontendIPConfiguration]
[Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxFrontendIPConfiguration]
$FrontEndIPConfiguration,
[Parameter()]
[Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.INginxNetworkInterfaceConfiguration]
[Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxNetworkInterfaceConfiguration]
$NetworkInterfaceConfiguration
)

process {
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.NginxNetworkProfile]::New()
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.NginxNetworkProfile]::New()

if ($PSBoundParameters.ContainsKey('FrontEndIPConfiguration')) {
$Object.FrontEndIPConfiguration = $FrontEndIPConfiguration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ Create an in-memory object for NginxConfigurationFile.
Create an in-memory object for NginxConfigurationFile.

.Outputs
Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.NginxConfigurationFile
Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.NginxConfigurationFile
.Link
https://learn.microsoft.com/powershell/module/Az.Nginx/new-AzNginxConfigurationFileObject
https://learn.microsoft.com/powershell/module/Az.Nginx/new-aznginxconfigurationfileobject
#>
function New-AzNginxConfigurationFileObject {
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.NginxConfigurationFile')]
[Microsoft.Azure.PowerShell.Cmdlets.Nginx.ModelCmdletAttribute()]
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.NginxConfigurationFile')]
[CmdletBinding(PositionalBinding=$false)]
Param(

Expand All @@ -39,7 +40,7 @@ function New-AzNginxConfigurationFileObject {
)

process {
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.NginxConfigurationFile]::New()
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.NginxConfigurationFile]::New()

if ($PSBoundParameters.ContainsKey('Content')) {
$Object.Content = $Content
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,29 +21,30 @@ Create an in-memory object for NginxPrivateIPAddress.
Create an in-memory object for NginxPrivateIPAddress.

.Outputs
Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.NginxPrivateIPAddress
Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.NginxPrivateIPAddress
.Link
https://learn.microsoft.com/powershell/module/Az.Nginx/new-AzNginxPrivateIPAddressObject
https://learn.microsoft.com/powershell/module/Az.Nginx/new-aznginxprivateipaddressobject
#>
function New-AzNginxPrivateIPAddressObject {
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.NginxPrivateIPAddress')]
[Microsoft.Azure.PowerShell.Cmdlets.Nginx.ModelCmdletAttribute()]
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.NginxPrivateIPAddress')]
[CmdletBinding(PositionalBinding=$false)]
Param(

[Parameter()]
[string]
$PrivateIPAddress,
[Parameter()]
[ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.Nginx.Support.NginxPrivateIPAllocationMethod])]
[Microsoft.Azure.PowerShell.Cmdlets.Nginx.Support.NginxPrivateIPAllocationMethod]
[Microsoft.Azure.PowerShell.Cmdlets.Nginx.PSArgumentCompleterAttribute("Static", "Dynamic")]
[string]
$PrivateIPAllocationMethod,
[Parameter()]
[string]
$SubnetId
)

process {
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.NginxPrivateIPAddress]::New()
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.NginxPrivateIPAddress]::New()

if ($PSBoundParameters.ContainsKey('PrivateIPAddress')) {
$Object.PrivateIPAddress = $PrivateIPAddress
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ Create an in-memory object for NginxPublicIPAddress.
Create an in-memory object for NginxPublicIPAddress.

.Outputs
Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.NginxPublicIPAddress
Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.NginxPublicIPAddress
.Link
https://learn.microsoft.com/powershell/module/Az.Nginx/new-AzNginxPublicIPAddressObject
https://learn.microsoft.com/powershell/module/Az.Nginx/new-aznginxpublicipaddressobject
#>
function New-AzNginxPublicIPAddressObject {
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.NginxPublicIPAddress')]
[Microsoft.Azure.PowerShell.Cmdlets.Nginx.ModelCmdletAttribute()]
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.NginxPublicIPAddress')]
[CmdletBinding(PositionalBinding=$false)]
Param(

Expand All @@ -36,7 +37,7 @@ function New-AzNginxPublicIPAddressObject {
)

process {
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.NginxPublicIPAddress]::New()
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.NginxPublicIPAddress]::New()

if ($PSBoundParameters.ContainsKey('Id')) {
$Object.Id = $Id
Expand Down
12 changes: 9 additions & 3 deletions src/Nginx/Nginx.Autorest/docs/Az.Nginx.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@ Get the NGINX deployment
Analyze an NGINX configuration without applying it to the NGINXaaS deployment

### [New-AzNginxCertificate](New-AzNginxCertificate.md)
Create or update the NGINX certificates for given NGINX deployment
Create the NGINX certificates for given NGINX deployment

### [New-AzNginxConfiguration](New-AzNginxConfiguration.md)
Create or update the NGINX configuration for given NGINX deployment
Create the NGINX configuration for given NGINX deployment

### [New-AzNginxConfigurationFileObject](New-AzNginxConfigurationFileObject.md)
Create an in-memory object for NginxConfigurationFile.

### [New-AzNginxDeployment](New-AzNginxDeployment.md)
Create or update the NGINX deployment
Create the NGINX deployment

### [New-AzNginxNetworkProfileObject](New-AzNginxNetworkProfileObject.md)
Create an in-memory object for NginxNetworkProfile.
Expand All @@ -53,6 +53,12 @@ Reset the NGINX configuration of given NGINX deployment to default
### [Remove-AzNginxDeployment](Remove-AzNginxDeployment.md)
Delete the NGINX deployment resource

### [Update-AzNginxCertificate](Update-AzNginxCertificate.md)
Update the NGINX certificates for given NGINX deployment

### [Update-AzNginxConfiguration](Update-AzNginxConfiguration.md)
Update the NGINX configuration for given NGINX deployment

### [Update-AzNginxDeployment](Update-AzNginxDeployment.md)
Update the NGINX deployment

26 changes: 23 additions & 3 deletions src/Nginx/Nginx.Autorest/docs/Get-AzNginxCertificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ Get-AzNginxCertificate -DeploymentName <String> -Name <String> -ResourceGroupNam
Get-AzNginxCertificate -InputObject <INginxIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>]
```

### GetViaIdentityNginxDeployment
```
Get-AzNginxCertificate -Name <String> -NginxDeploymentInputObject <INginxIdentity>
[-DefaultProfile <PSObject>] [<CommonParameters>]
```

## DESCRIPTION
Get a certificate of given NGINX deployment

Expand Down Expand Up @@ -96,7 +102,6 @@ Accept wildcard characters: False

### -InputObject
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity
Expand All @@ -115,7 +120,7 @@ The name of certificate

```yaml
Type: System.String
Parameter Sets: Get
Parameter Sets: Get, GetViaIdentityNginxDeployment
Aliases: CertificateName

Required: True
Expand All @@ -125,6 +130,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -NginxDeploymentInputObject
Identity Parameter

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxIdentity
Parameter Sets: GetViaIdentityNginxDeployment
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```

### -ResourceGroupName
The name of the resource group.
The name is case insensitive.
Expand Down Expand Up @@ -165,7 +185,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.INginxCertificate
### Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.INginxCertificate

## NOTES

Expand Down
Loading