Invoke-AzNginxAnalysisConfiguration

  • Reference
Module:
Az.Nginx

Analyze an NGINX configuration without applying it to the NGINXaaS deployment

Syntax

Invoke-AzNginxAnalysisConfiguration
      -ConfigurationName <String>
      -DeploymentName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-ConfigFile <INginxConfigurationFile[]>]
      [-ConfigProtectedFile <INginxConfigurationFile[]>]
      [-ConfigRootFile <String>]
      [-PackageData <String>]
      [-PackageProtectedFile <String[]>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-AzNginxAnalysisConfiguration
      -ConfigurationName <String>
      -DeploymentName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -Body <IAnalysisCreate>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-AzNginxAnalysisConfiguration
      -InputObject <INginxIdentity>
      [-ConfigFile <INginxConfigurationFile[]>]
      [-ConfigProtectedFile <INginxConfigurationFile[]>]
      [-ConfigRootFile <String>]
      [-PackageData <String>]
      [-PackageProtectedFile <String[]>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-AzNginxAnalysisConfiguration
      -InputObject <INginxIdentity>
      -Body <IAnalysisCreate>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Analyze an NGINX configuration without applying it to the NGINXaaS deployment

Examples

Example 1: Analyzing nginx configuration before creating the nginx configuration

$confFile = New-AzNginxConfigurationFileObject -VirtualPath "nginx.conf" -Content 'xxxx'
        
# configuration analysis
$confAnalysis = Invoke-AzNginxAnalysisConfiguration -ConfigurationName default -DeploymentName xxxx -ResourceGroupName xxxx -ConfigFile $confFile -ConfigRootFile "nginx.conf"

Status
------
SUCCEEDED

This command analyzes the configuration before you submit to create your configuration for your nginx deployment

Parameters

-Body

The request body for creating an analysis for an NGINX configuration. To construct, see NOTES section for BODY properties and create a hash table.

Type:Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.IAnalysisCreate
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ConfigFile

. To construct, see NOTES section for CONFIGFILE properties and create a hash table.

Type:Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.INginxConfigurationFile[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConfigProtectedFile

. To construct, see NOTES section for CONFIGPROTECTEDFILE properties and create a hash table.

Type:Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.INginxConfigurationFile[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConfigRootFile

The root file of the NGINX config file(s). It must match one of the files' filepath.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConfigurationName

The name of configuration, only 'default' is supported value due to the singleton of NGINX conf

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeploymentName

The name of targeted NGINX deployment

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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

Type:INginxIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PackageData

.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PackageProtectedFile

.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.IAnalysisCreate

INginxIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.IAnalysisResult