Invoke-AzNginxAnalysisConfiguration
Analyze an NGINX configuration without applying it to the NGINXaaS deployment
Syntax
AnalysisExpanded (Default)
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>]
Analysis
Invoke-AzNginxAnalysisConfiguration
-ConfigurationName <String>
-DeploymentName <String>
-ResourceGroupName <String>
-Body <IAnalysisCreate>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
AnalysisViaIdentityExpanded
Invoke-AzNginxAnalysisConfiguration
-InputObject <INginxIdentity>
[-ConfigFile <INginxConfigurationFile[]>]
[-ConfigProtectedFile <INginxConfigurationFile[]>]
[-ConfigRootFile <String>]
[-PackageData <String>]
[-PackageProtectedFile <String[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
AnalysisViaIdentity
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.
Parameter properties
Type: IAnalysisCreate
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Analysis
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
AnalysisViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ConfigFile
.
To construct, see NOTES section for CONFIGFILE properties and create a hash table.
Parameter properties
Parameter sets
AnalysisExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AnalysisViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ConfigProtectedFile
.
To construct, see NOTES section for CONFIGPROTECTEDFILE properties and create a hash table.
Parameter properties
Parameter sets
AnalysisExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AnalysisViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ConfigRootFile
The root file of the NGINX config file(s).
It must match one of the files' filepath.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
AnalysisExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AnalysisViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ConfigurationName
The name of configuration, only 'default' is supported value due to the singleton of NGINX conf
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
AnalysisExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Analysis
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DeploymentName
The name of targeted NGINX deployment
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
AnalysisExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Analysis
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: INginxIdentity
Default value: None Supports wildcards: False DontShow: False
AnalysisViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
AnalysisViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-PackageData
.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
AnalysisExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AnalysisViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PackageProtectedFile
.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
AnalysisExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AnalysisViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
AnalysisExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Analysis
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
AnalysisExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Analysis
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
