Nginx.NginxPlus (preview:2024-11-01)

2025/01/10 • 1 updated methods

Configurations_Analysis (updated)
Description :  Analyze an NGINX configuration without applying it to the NGINXaaS deployment
Reference :  Link ¶

⚶ Changes

{
  "#id": "Configurations_Analysis",
  "$responses": {
    "200": {
      "$properties": {
        "data": [
          {
            "diagnostics": {
              "Description": {
                "new": "A diagnostic is a message associated with an NGINX config. The Analyzer returns diagnostics with a level indicating the importance of the diagnostic with optional category.",
                "old": "A config diagnostic object found during the analysis of an NGINX configuration that can be a warning or recommendation."
              },
              "$properties": [
                {
                  "#name": "id",
                  "Description": {
                    "new": "Unique identifier for the diagnostic.",
                    "old": "Unique identifier for the error"
                  }
                },
                {
                  "#name": "file",
                  "Description": {
                    "new": "The filepath of the most relevant config file.",
                    "old": "the filepath of the most relevant config file"
                  }
                },
                {
                  "#name": "category",
                  "Description": {
                    "new": "Category of warning like Best-practices, Recommendation, Security etc.",
                    "old": "category of warning"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}/analyze
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of targeted NGINX deployment ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of configuration, only 'default' is supported value due to the singleton of NGINX conf ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The NGINX configuration to analyze ,
Required: False ,
}
{
config:
{
Required: True ,
}
{
rootFile:
{
Description: The root file of the NGINX config file(s). It must match one of the files' filepath. ,
Required: False ,
}
string ,
files:
{
Required: False ,
}
[
{
content:
{
Required: False ,
}
string ,
virtualPath:
{
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Required: False ,
}
[
{
content:
{
Description: The content of the protected file. This value is a PUT only value. If you perform a GET request on this value, it will be empty because it is a protected file. ,
Required: False ,
}
string ,
virtualPath:
{
Description: The virtual path of the protected file. ,
Required: False ,
}
string ,
contentHash:
{
Description: The hash of the content of the file. This value is used to determine if the file has changed. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Required: False ,
}
{
data:
{
Required: False ,
}
string ,
protectedFiles:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
status:
{
Description: The status of the analysis. ,
Required: True ,
}
string ,
data:
{
Required: False ,
}
{
errors:
{
Required: False ,
}
[
{
id:
{
Description: Unique identifier for the error ,
Required: False ,
}
string ,
directive:
{
Required: True ,
}
string ,
description:
{
Required: True ,
}
string ,
file:
{
Description: the filepath of the most relevant config file ,
Required: True ,
}
string ,
line:
{
Required: True ,
}
number ,
message:
{
Required: True ,
}
string ,
rule:
{
Required: True ,
}
string ,
}
,
]
,
diagnostics:
{
Required: False ,
}
[
{
id:
{
Description: Unique identifier for the diagnostic. ,
Required: False ,
}
string ,
directive:
{
Required: True ,
}
string ,
description:
{
Required: True ,
}
string ,
file:
{
Description: The filepath of the most relevant config file. ,
Required: True ,
}
string ,
line:
{
Required: True ,
}
number ,
message:
{
Required: True ,
}
string ,
rule:
{
Required: True ,
}
string ,
level:
{
Description: Warning or Info ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
}
,
Required: True ,
}
enum ,
category:
{
Description: Category of warning like Best-practices, Recommendation, Security etc. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}