azure.mgmt.nginx.models module

class azure.mgmt.nginx.models.ActivationState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The activation state of the WAF. Use ‘Enabled’ to enable the WAF and ‘Disabled’ to disable it.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.nginx.models.AnalysisCreate(*, config: _models.AnalysisCreateConfig, **kwargs: Any)[source]

Bases: Model

The request body for creating an analysis for an NGINX configuration.

All required parameters must be populated in order to send to server.

Variables:: config (AnalysisCreateConfig) – Required.
Keyword Arguments:: config (AnalysisCreateConfig) – Required.

class azure.mgmt.nginx.models.AnalysisCreateConfig(*, root_file: str | None = None, files: List[_models.NginxConfigurationFile] | None = None, protected_files: List[_models.NginxConfigurationProtectedFileRequest] | None = None, package: _models.NginxConfigurationPackage | None = None, **kwargs: Any)[source]

Bases: Model

AnalysisCreateConfig.

Variables:

root_file (str) – The root file of the NGINX config file(s). It must match one of the files’ filepath.
files (list[NginxConfigurationFile])
protected_files (list[NginxConfigurationProtectedFileRequest])
package (NginxConfigurationPackage)

Keyword Arguments:

root_file (str) – The root file of the NGINX config file(s). It must match one of the files’ filepath.
files (list[NginxConfigurationFile])
protected_files (list[NginxConfigurationProtectedFileRequest])
package (NginxConfigurationPackage)

class azure.mgmt.nginx.models.AnalysisDiagnostic(*, directive: str, description: str, file: str, line: float, message: str, rule: str, id: str | None = None, **kwargs: Any)[source]

Bases: Model

An error object found during the analysis of an NGINX configuration.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Unique identifier for the error.
directive (str) – Required.
description (str) – Required.
file (str) – the filepath of the most relevant config file. Required.
line (float) – Required.
message (str) – Required.
rule (str) – Required.

Keyword Arguments:

id (str) – Unique identifier for the error.
directive (str) – Required.
description (str) – Required.
file (str) – the filepath of the most relevant config file. Required.
line (float) – Required.
message (str) – Required.
rule (str) – Required.

class azure.mgmt.nginx.models.AnalysisResult(*, status: str, data: _models.AnalysisResultData | None = None, **kwargs: Any)[source]

Bases: Model

The response body for an analysis request. Contains the status of the analysis and any errors.

All required parameters must be populated in order to send to server.

Variables:

status (str) – The status of the analysis. Required.
data (AnalysisResultData)

Keyword Arguments:

status (str) – The status of the analysis. Required.
data (AnalysisResultData)

class azure.mgmt.nginx.models.AnalysisResultData(*, errors: List[_models.AnalysisDiagnostic] | None = None, diagnostics: List[_models.DiagnosticItem] | None = None, **kwargs: Any)[source]

Bases: Model

AnalysisResultData.

Variables:

errors (list[AnalysisDiagnostic])
diagnostics (list[DiagnosticItem])

Keyword Arguments:

errors (list[AnalysisDiagnostic])
diagnostics (list[DiagnosticItem])

class azure.mgmt.nginx.models.AutoUpgradeProfile(*, upgrade_channel: str, **kwargs: Any)[source]

Bases: Model

Autoupgrade settings of a deployment.

All required parameters must be populated in order to send to server.

Variables:: upgrade_channel (str) – Channel used for autoupgrade. Required.
Keyword Arguments:: upgrade_channel (str) – Channel used for autoupgrade. Required.

class azure.mgmt.nginx.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'

KEY = 'Key'

MANAGED_IDENTITY = 'ManagedIdentity'

USER = 'User'

class azure.mgmt.nginx.models.DiagnosticItem(*, directive: str, description: str, file: str, line: float, message: str, rule: str, level: str | _models.Level, id: str | None = None, category: str | None = None, **kwargs: Any)[source]

Bases: Model

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.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Unique identifier for the diagnostic.
directive (str) – Required.
description (str) – Required.
file (str) – The filepath of the most relevant config file. Required.
line (float) – Required.
message (str) – Required.
rule (str) – Required.
level (str or Level) – Warning or Info. Required. Known values are: “Info” and “Warning”.
category (str) – Category of warning like Best-practices, Recommendation, Security etc.

Keyword Arguments:

id (str) – Unique identifier for the diagnostic.
directive (str) – Required.
description (str) – Required.
file (str) – The filepath of the most relevant config file. Required.
line (float) – Required.
message (str) – Required.
rule (str) – Required.
level (str or Level) – Warning or Info. Required. Known values are: “Info” and “Warning”.
category (str) – Category of warning like Best-practices, Recommendation, Security etc.

class azure.mgmt.nginx.models.ErrorAdditionalInfo(**kwargs: Any)[source]

Bases: Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

type (str) – The additional info type.
info (JSON) – The additional info.

class azure.mgmt.nginx.models.ErrorDetail(**kwargs: Any)[source]

Bases: Model

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.nginx.models.ErrorResponse(*, error: _models.ErrorDetail | None = None, **kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables:: error (ErrorDetail) – The error object.
Keyword Arguments:: error (ErrorDetail) – The error object.

class azure.mgmt.nginx.models.IdentityProperties(*, type: str | _models.IdentityType | None = None, user_assigned_identities: Dict[str, _models.UserIdentityProperties] | None = None, **kwargs: Any)[source]

Bases: Model

IdentityProperties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

principal_id (str)
tenant_id (str)
type (str or IdentityType) – Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
user_assigned_identities (dict[str, UserIdentityProperties]) – Dictionary of <UserIdentityProperties>.

Keyword Arguments:

type (str or IdentityType) – Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
user_assigned_identities (dict[str, UserIdentityProperties]) – Dictionary of <UserIdentityProperties>.

class azure.mgmt.nginx.models.IdentityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

IdentityType.

NONE = 'None'

SYSTEM_ASSIGNED = 'SystemAssigned'

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'

USER_ASSIGNED = 'UserAssigned'

class azure.mgmt.nginx.models.Level(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Warning or Info.

INFO = 'Info'

WARNING = 'Warning'

class azure.mgmt.nginx.models.NginxCertificate(*, properties: _models.NginxCertificateProperties | None = None, location: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxCertificate.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str)
name (str)
type (str)
properties (NginxCertificateProperties)
location (str)
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments:

properties (NginxCertificateProperties)
location (str)

class azure.mgmt.nginx.models.NginxCertificateErrorResponseBody(*, code: str | None = None, message: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxCertificateErrorResponseBody.

Variables:

code (str)
message (str)

Keyword Arguments:

code (str)
message (str)

class azure.mgmt.nginx.models.NginxCertificateListResponse(*, value: List[_models.NginxCertificate] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxCertificateListResponse.

Variables:

value (list[NginxCertificate])
next_link (str)

Keyword Arguments:

value (list[NginxCertificate])
next_link (str)

class azure.mgmt.nginx.models.NginxCertificateProperties(*, key_virtual_path: str | None = None, certificate_virtual_path: str | None = None, key_vault_secret_id: str | None = None, certificate_error: _models.NginxCertificateErrorResponseBody | None = None, **kwargs: Any)[source]

Bases: Model

NginxCertificateProperties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

provisioning_state (str or ProvisioningState) – Known values are: “Accepted”, “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Canceled”, “Deleted”, and “NotSpecified”.
key_virtual_path (str)
certificate_virtual_path (str)
key_vault_secret_id (str)
sha1_thumbprint (str)
key_vault_secret_version (str)
key_vault_secret_created (datetime)
certificate_error (NginxCertificateErrorResponseBody)

Keyword Arguments:

key_virtual_path (str)
certificate_virtual_path (str)
key_vault_secret_id (str)
certificate_error (NginxCertificateErrorResponseBody)

class azure.mgmt.nginx.models.NginxConfigurationFile(*, content: str | None = None, virtual_path: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxConfigurationFile.

Variables:

content (str)
virtual_path (str)

Keyword Arguments:

content (str)
virtual_path (str)

class azure.mgmt.nginx.models.NginxConfigurationListResponse(*, value: List[_models.NginxConfigurationResponse] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

Response of a list operation.

Variables:

value (list[NginxConfigurationResponse]) – Results of a list operation.
next_link (str) – Link to the next set of results, if any.

Keyword Arguments:

value (list[NginxConfigurationResponse]) – Results of a list operation.
next_link (str) – Link to the next set of results, if any.

class azure.mgmt.nginx.models.NginxConfigurationPackage(*, data: str | None = None, protected_files: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

NginxConfigurationPackage.

Variables:

data (str)
protected_files (list[str])

Keyword Arguments:

data (str)
protected_files (list[str])

class azure.mgmt.nginx.models.NginxConfigurationProtectedFileRequest(*, content: str | None = None, virtual_path: str | None = None, content_hash: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxConfigurationProtectedFileRequest.

Variables:

content (str) – 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.
virtual_path (str) – The virtual path of the protected file.
content_hash (str) – The hash of the content of the file. This value is used to determine if the file has changed.

Keyword Arguments:

content (str) – 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.
virtual_path (str) – The virtual path of the protected file.
content_hash (str) – The hash of the content of the file. This value is used to determine if the file has changed.

class azure.mgmt.nginx.models.NginxConfigurationProtectedFileResponse(*, virtual_path: str | None = None, content_hash: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxConfigurationProtectedFileResponse.

Variables:

virtual_path (str) – The virtual path of the protected file.
content_hash (str) – The hash of the content of the file. This value is used to determine if the file has changed.

Keyword Arguments:

virtual_path (str) – The virtual path of the protected file.
content_hash (str) – The hash of the content of the file. This value is used to determine if the file has changed.

class azure.mgmt.nginx.models.NginxConfigurationRequest(*, properties: _models.NginxConfigurationRequestProperties | None = None, **kwargs: Any)[source]

Bases: Model

NginxConfigurationRequest.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str)
name (str)
type (str)
properties (NginxConfigurationRequestProperties)
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments:

properties (NginxConfigurationRequestProperties)

class azure.mgmt.nginx.models.NginxConfigurationRequestProperties(*, files: List[_models.NginxConfigurationFile] | None = None, protected_files: List[_models.NginxConfigurationProtectedFileRequest] | None = None, package: _models.NginxConfigurationPackage | None = None, root_file: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxConfigurationRequestProperties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

provisioning_state (str or ProvisioningState) – Known values are: “Accepted”, “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Canceled”, “Deleted”, and “NotSpecified”.
files (list[NginxConfigurationFile])
protected_files (list[NginxConfigurationProtectedFileRequest])
package (NginxConfigurationPackage)
root_file (str)

Keyword Arguments:

files (list[NginxConfigurationFile])
protected_files (list[NginxConfigurationProtectedFileRequest])
package (NginxConfigurationPackage)
root_file (str)

class azure.mgmt.nginx.models.NginxConfigurationResponse(*, properties: _models.NginxConfigurationResponseProperties | None = None, **kwargs: Any)[source]

Bases: Model

NginxConfigurationResponse.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str)
name (str)
type (str)
properties (NginxConfigurationResponseProperties)
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments:

properties (NginxConfigurationResponseProperties)

class azure.mgmt.nginx.models.NginxConfigurationResponseProperties(*, files: List[_models.NginxConfigurationFile] | None = None, protected_files: List[_models.NginxConfigurationProtectedFileResponse] | None = None, package: _models.NginxConfigurationPackage | None = None, root_file: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxConfigurationResponseProperties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

provisioning_state (str or ProvisioningState) – Known values are: “Accepted”, “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Canceled”, “Deleted”, and “NotSpecified”.
files (list[NginxConfigurationFile])
protected_files (list[NginxConfigurationProtectedFileResponse])
package (NginxConfigurationPackage)
root_file (str)

Keyword Arguments:

files (list[NginxConfigurationFile])
protected_files (list[NginxConfigurationProtectedFileResponse])
package (NginxConfigurationPackage)
root_file (str)

class azure.mgmt.nginx.models.NginxDeployment(*, identity: _models.IdentityProperties | None = None, properties: _models.NginxDeploymentProperties | None = None, tags: Dict[str, str] | None = None, sku: _models.ResourceSku | None = None, location: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxDeployment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str)
name (str)
type (str)
identity (IdentityProperties)
properties (NginxDeploymentProperties)
tags (dict[str, str]) – Dictionary of <string>.
sku (ResourceSku)
location (str)
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments:

identity (IdentityProperties)
properties (NginxDeploymentProperties)
tags (dict[str, str]) – Dictionary of <string>.
sku (ResourceSku)
location (str)

class azure.mgmt.nginx.models.NginxDeploymentApiKeyListResponse(*, value: List[_models.NginxDeploymentApiKeyResponse] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxDeploymentApiKeyListResponse.

Variables:

value (list[NginxDeploymentApiKeyResponse])
next_link (str)

Keyword Arguments:

value (list[NginxDeploymentApiKeyResponse])
next_link (str)

class azure.mgmt.nginx.models.NginxDeploymentApiKeyRequest(*, properties: _models.NginxDeploymentApiKeyRequestProperties | None = None, **kwargs: Any)[source]

Bases: Model

NginxDeploymentApiKeyRequest.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str)
name (str)
type (str)
properties (NginxDeploymentApiKeyRequestProperties)

Keyword Arguments:

properties (NginxDeploymentApiKeyRequestProperties)

class azure.mgmt.nginx.models.NginxDeploymentApiKeyRequestProperties(*, secret_text: str | None = None, end_date_time: datetime | None = None, **kwargs: Any)[source]

Bases: Model

NginxDeploymentApiKeyRequestProperties.

Variables:

secret_text (str) – Secret text to be used as a Dataplane API Key. This is a write only property that can never be read back, but the first three characters will be returned in the ‘hint’ property.
end_date_time (datetime) – The time after which this Dataplane API Key is no longer valid.

Keyword Arguments:

secret_text (str) – Secret text to be used as a Dataplane API Key. This is a write only property that can never be read back, but the first three characters will be returned in the ‘hint’ property.
end_date_time (datetime) – The time after which this Dataplane API Key is no longer valid.

class azure.mgmt.nginx.models.NginxDeploymentApiKeyResponse(*, properties: _models.NginxDeploymentApiKeyResponseProperties | None = None, **kwargs: Any)[source]

Bases: Model

NginxDeploymentApiKeyResponse.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str)
name (str)
type (str)
properties (NginxDeploymentApiKeyResponseProperties)

Keyword Arguments:

properties (NginxDeploymentApiKeyResponseProperties)

class azure.mgmt.nginx.models.NginxDeploymentApiKeyResponseProperties(*, end_date_time: datetime | None = None, **kwargs: Any)[source]

Bases: Model

NginxDeploymentApiKeyResponseProperties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

hint (str) – The first three characters of the secret text to help identify it in use. This property is read-only.
end_date_time (datetime) – The time after which this Dataplane API Key is no longer valid.

Keyword Arguments:

end_date_time (datetime) – The time after which this Dataplane API Key is no longer valid.

class azure.mgmt.nginx.models.NginxDeploymentListResponse(*, value: List[_models.NginxDeployment] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxDeploymentListResponse.

Variables:

value (list[NginxDeployment])
next_link (str)

Keyword Arguments:

value (list[NginxDeployment])
next_link (str)

class azure.mgmt.nginx.models.NginxDeploymentProperties(*, network_profile: _models.NginxNetworkProfile | None = None, enable_diagnostics_support: bool | None = None, logging: _models.NginxLogging | None = None, scaling_properties: _models.NginxDeploymentScalingProperties | None = None, auto_upgrade_profile: _models.AutoUpgradeProfile | None = None, user_profile: _models.NginxDeploymentUserProfile | None = None, nginx_app_protect: _models.NginxDeploymentPropertiesNginxAppProtect | None = None, **kwargs: Any)[source]

Bases: Model

NginxDeploymentProperties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

provisioning_state (str or ProvisioningState) – Known values are: “Accepted”, “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Canceled”, “Deleted”, and “NotSpecified”.
nginx_version (str)
network_profile (NginxNetworkProfile)
ip_address (str) – The IP address of the deployment.
enable_diagnostics_support (bool)
logging (NginxLogging)
scaling_properties (NginxDeploymentScalingProperties) – Information on how the deployment will be scaled.
auto_upgrade_profile (AutoUpgradeProfile) – Autoupgrade settings of a deployment.
user_profile (NginxDeploymentUserProfile)
nginx_app_protect (NginxDeploymentPropertiesNginxAppProtect) – Settings for NGINX App Protect (NAP).
dataplane_api_endpoint (str) – Dataplane API endpoint for the caller to update the NGINX state of the deployment.

Keyword Arguments:

network_profile (NginxNetworkProfile)
enable_diagnostics_support (bool)
logging (NginxLogging)
scaling_properties (NginxDeploymentScalingProperties) – Information on how the deployment will be scaled.
auto_upgrade_profile (AutoUpgradeProfile) – Autoupgrade settings of a deployment.
user_profile (NginxDeploymentUserProfile)
nginx_app_protect (NginxDeploymentPropertiesNginxAppProtect) – Settings for NGINX App Protect (NAP).

class azure.mgmt.nginx.models.NginxDeploymentPropertiesNginxAppProtect(*, web_application_firewall_settings: _models.WebApplicationFirewallSettings, **kwargs: Any)[source]

Bases: Model

Settings for NGINX App Protect (NAP).

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

web_application_firewall_settings (WebApplicationFirewallSettings) – Settings for the NGINX App Protect Web Application Firewall (WAF). Required.
web_application_firewall_status (WebApplicationFirewallStatus) – The status of the NGINX App Protect Web Application Firewall.

Keyword Arguments:

web_application_firewall_settings (WebApplicationFirewallSettings) – Settings for the NGINX App Protect Web Application Firewall (WAF). Required.

class azure.mgmt.nginx.models.NginxDeploymentScalingProperties(*, capacity: int | None = None, profiles: List[_models.ScaleProfile] | None = None, **kwargs: Any)[source]

Bases: Model

Information on how the deployment will be scaled.

Variables:

capacity (int)
profiles (list[ScaleProfile])

Keyword Arguments:

capacity (int)
profiles (list[ScaleProfile])

class azure.mgmt.nginx.models.NginxDeploymentUpdateParameters(*, identity: _models.IdentityProperties | None = None, tags: Dict[str, str] | None = None, sku: _models.ResourceSku | None = None, location: str | None = None, properties: _models.NginxDeploymentUpdateProperties | None = None, **kwargs: Any)[source]

Bases: Model

NginxDeploymentUpdateParameters.

Variables:

identity (IdentityProperties)
tags (dict[str, str]) – Dictionary of <string>.
sku (ResourceSku)
location (str)
properties (NginxDeploymentUpdateProperties)

Keyword Arguments:

identity (IdentityProperties)
tags (dict[str, str]) – Dictionary of <string>.
sku (ResourceSku)
location (str)
properties (NginxDeploymentUpdateProperties)

class azure.mgmt.nginx.models.NginxDeploymentUpdateProperties(*, enable_diagnostics_support: bool | None = None, logging: _models.NginxLogging | None = None, scaling_properties: _models.NginxDeploymentScalingProperties | None = None, user_profile: _models.NginxDeploymentUserProfile | None = None, network_profile: _models.NginxNetworkProfile | None = None, auto_upgrade_profile: _models.AutoUpgradeProfile | None = None, nginx_app_protect: _models.NginxDeploymentUpdatePropertiesNginxAppProtect | None = None, **kwargs: Any)[source]

Bases: Model

NginxDeploymentUpdateProperties.

Variables:

enable_diagnostics_support (bool)
logging (NginxLogging)
scaling_properties (NginxDeploymentScalingProperties) – Information on how the deployment will be scaled.
user_profile (NginxDeploymentUserProfile)
network_profile (NginxNetworkProfile)
auto_upgrade_profile (AutoUpgradeProfile) – Autoupgrade settings of a deployment.
nginx_app_protect (NginxDeploymentUpdatePropertiesNginxAppProtect) – Update settings for NGINX App Protect (NAP).

Keyword Arguments:

enable_diagnostics_support (bool)
logging (NginxLogging)
scaling_properties (NginxDeploymentScalingProperties) – Information on how the deployment will be scaled.
user_profile (NginxDeploymentUserProfile)
network_profile (NginxNetworkProfile)
auto_upgrade_profile (AutoUpgradeProfile) – Autoupgrade settings of a deployment.
nginx_app_protect (NginxDeploymentUpdatePropertiesNginxAppProtect) – Update settings for NGINX App Protect (NAP).

class azure.mgmt.nginx.models.NginxDeploymentUpdatePropertiesNginxAppProtect(*, web_application_firewall_settings: _models.WebApplicationFirewallSettings | None = None, **kwargs: Any)[source]

Bases: Model

Update settings for NGINX App Protect (NAP).

Variables:: web_application_firewall_settings (WebApplicationFirewallSettings) – Settings for the NGINX App Protect Web Application Firewall (WAF).
Keyword Arguments:: web_application_firewall_settings (WebApplicationFirewallSettings) – Settings for the NGINX App Protect Web Application Firewall (WAF).

class azure.mgmt.nginx.models.NginxDeploymentUserProfile(*, preferred_email: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxDeploymentUserProfile.

Variables:: preferred_email (str) – The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address.
Keyword Arguments:: preferred_email (str) – The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address.

class azure.mgmt.nginx.models.NginxFrontendIPConfiguration(*, public_ip_addresses: List[_models.NginxPublicIPAddress] | None = None, private_ip_addresses: List[_models.NginxPrivateIPAddress] | None = None, **kwargs: Any)[source]

Bases: Model

NginxFrontendIPConfiguration.

Variables:

public_ip_addresses (list[NginxPublicIPAddress])
private_ip_addresses (list[NginxPrivateIPAddress])

Keyword Arguments:

public_ip_addresses (list[NginxPublicIPAddress])
private_ip_addresses (list[NginxPrivateIPAddress])

class azure.mgmt.nginx.models.NginxLogging(*, storage_account: _models.NginxStorageAccount | None = None, **kwargs: Any)[source]

Bases: Model

NginxLogging.

Variables:: storage_account (NginxStorageAccount)
Keyword Arguments:: storage_account (NginxStorageAccount)

class azure.mgmt.nginx.models.NginxNetworkInterfaceConfiguration(*, subnet_id: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxNetworkInterfaceConfiguration.

Variables:: subnet_id (str)
Keyword Arguments:: subnet_id (str)

class azure.mgmt.nginx.models.NginxNetworkProfile(*, front_end_ip_configuration: _models.NginxFrontendIPConfiguration | None = None, network_interface_configuration: _models.NginxNetworkInterfaceConfiguration | None = None, **kwargs: Any)[source]

Bases: Model

NginxNetworkProfile.

Variables:

front_end_ip_configuration (NginxFrontendIPConfiguration)
network_interface_configuration (NginxNetworkInterfaceConfiguration)

Keyword Arguments:

front_end_ip_configuration (NginxFrontendIPConfiguration)
network_interface_configuration (NginxNetworkInterfaceConfiguration)

class azure.mgmt.nginx.models.NginxPrivateIPAddress(*, private_ip_address: str | None = None, private_ip_allocation_method: str | _models.NginxPrivateIPAllocationMethod | None = None, subnet_id: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxPrivateIPAddress.

Variables:

private_ip_address (str)
private_ip_allocation_method (str or NginxPrivateIPAllocationMethod) – Known values are: “Static” and “Dynamic”.
subnet_id (str)

Keyword Arguments:

private_ip_address (str)
private_ip_allocation_method (str or NginxPrivateIPAllocationMethod) – Known values are: “Static” and “Dynamic”.
subnet_id (str)

class azure.mgmt.nginx.models.NginxPrivateIPAllocationMethod(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

NginxPrivateIPAllocationMethod.

DYNAMIC = 'Dynamic'

STATIC = 'Static'

class azure.mgmt.nginx.models.NginxPublicIPAddress(*, id: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxPublicIPAddress.

Variables:: id (str)
Keyword Arguments:: id (str)

class azure.mgmt.nginx.models.NginxStorageAccount(*, account_name: str | None = None, container_name: str | None = None, **kwargs: Any)[source]

Bases: Model

NginxStorageAccount.

Variables:

account_name (str)
container_name (str)

Keyword Arguments:

account_name (str)
container_name (str)

class azure.mgmt.nginx.models.OperationDisplay(*, provider: str | None = None, resource: str | None = None, operation: str | None = None, description: str | None = None, **kwargs: Any)[source]

Bases: Model

The object that represents the operation.

Variables:

provider (str) – Service provider: Nginx.NginxPlus.
resource (str) – Type on which the operation is performed, e.g., ‘deployments’.
operation (str) – Operation type, e.g., read, write, delete, etc.
description (str) – Description of the operation, e.g., ‘Write deployments’.

Keyword Arguments:

provider (str) – Service provider: Nginx.NginxPlus.
resource (str) – Type on which the operation is performed, e.g., ‘deployments’.
operation (str) – Operation type, e.g., read, write, delete, etc.
description (str) – Description of the operation, e.g., ‘Write deployments’.

class azure.mgmt.nginx.models.OperationListResult(*, value: List[_models.OperationResult] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

Result of GET request to list Nginx.NginxPlus operations.

Variables:

value (list[OperationResult]) – List of operations supported by the Nginx.NginxPlus provider.
next_link (str) – URL to get the next set of operation list results if there are any.

Keyword Arguments:

value (list[OperationResult]) – List of operations supported by the Nginx.NginxPlus provider.
next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.nginx.models.OperationResult(*, name: str | None = None, display: _models.OperationDisplay | None = None, is_data_action: bool | None = None, **kwargs: Any)[source]

Bases: Model

A Nginx.NginxPlus REST API operation.

Variables:

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that represents the operation.
is_data_action (bool) – Indicates whether the operation is a data action.

Keyword Arguments:

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that represents the operation.
is_data_action (bool) – Indicates whether the operation is a data action.

class azure.mgmt.nginx.models.ProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

ProvisioningState.

ACCEPTED = 'Accepted'

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETED = 'Deleted'

DELETING = 'Deleting'

FAILED = 'Failed'

NOT_SPECIFIED = 'NotSpecified'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.nginx.models.ResourceSku(*, name: str, **kwargs: Any)[source]

Bases: Model

ResourceSku.

All required parameters must be populated in order to send to server.

Variables:: name (str) – Name of the SKU. Required.
Keyword Arguments:: name (str) – Name of the SKU. Required.

class azure.mgmt.nginx.models.ScaleProfile(*, name: str, capacity: _models.ScaleProfileCapacity, **kwargs: Any)[source]

Bases: Model

The autoscale profile.

All required parameters must be populated in order to send to server.

Variables:

name (str) – Required.
capacity (ScaleProfileCapacity) – The capacity parameters of the profile. Required.

Keyword Arguments:

name (str) – Required.
capacity (ScaleProfileCapacity) – The capacity parameters of the profile. Required.

class azure.mgmt.nginx.models.ScaleProfileCapacity(*, min: int, max: int, **kwargs: Any)[source]

Bases: Model

The capacity parameters of the profile.

All required parameters must be populated in order to send to server.

Variables:

min (int) – The minimum number of NCUs the deployment can be autoscaled to. Required.
max (int) – The maximum number of NCUs the deployment can be autoscaled to. Required.

Keyword Arguments:

min (int) – The minimum number of NCUs the deployment can be autoscaled to. Required.
max (int) – The maximum number of NCUs the deployment can be autoscaled to. Required.

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.nginx.models.UserIdentityProperties(**kwargs: Any)[source]

Bases: Model

UserIdentityProperties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

principal_id (str)
client_id (str)

class azure.mgmt.nginx.models.WebApplicationFirewallComponentVersions(*, waf_engine_version: str, waf_nginx_version: str, **kwargs: Any)[source]

Bases: Model

Versions of the NGINX App Protect Web Application Firewall (WAF) components.

All required parameters must be populated in order to send to server.

Variables:

waf_engine_version (str) – The version of the NGINX App Protect Web Application Firewall (WAF) engine. Required.
waf_nginx_version (str) – The version of the NGINX App Protect Web Application Firewall (WAF) module for NGINX. Required.

Keyword Arguments:

waf_engine_version (str) – The version of the NGINX App Protect Web Application Firewall (WAF) engine. Required.
waf_nginx_version (str) – The version of the NGINX App Protect Web Application Firewall (WAF) module for NGINX. Required.

class azure.mgmt.nginx.models.WebApplicationFirewallPackage(*, version: str, revision_datetime: datetime, **kwargs: Any)[source]

Bases: Model

NGINX App Protect Web Application Firewall (WAF) Package. Contains the version and revision date of the package.

All required parameters must be populated in order to send to server.

Variables:

version (str) – The version of the NGINX App Protect Web Application Firewall (WAF) package. Required.
revision_datetime (datetime) – The date and time of the package revision. Required.

Keyword Arguments:

version (str) – The version of the NGINX App Protect Web Application Firewall (WAF) package. Required.
revision_datetime (datetime) – The date and time of the package revision. Required.

class azure.mgmt.nginx.models.WebApplicationFirewallSettings(*, activation_state: str | _models.ActivationState | None = None, **kwargs: Any)[source]

Bases: Model

Settings for the NGINX App Protect Web Application Firewall (WAF).

Variables:: activation_state (str or ActivationState) – The activation state of the WAF. Use ‘Enabled’ to enable the WAF and ‘Disabled’ to disable it. Known values are: “Enabled” and “Disabled”.
Keyword Arguments:: activation_state (str or ActivationState) – The activation state of the WAF. Use ‘Enabled’ to enable the WAF and ‘Disabled’ to disable it. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.nginx.models.WebApplicationFirewallStatus(**kwargs: Any)[source]

Bases: Model

The status of the NGINX App Protect Web Application Firewall.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

attack_signatures_package (WebApplicationFirewallPackage) – Package containing attack signatures for the NGINX App Protect Web Application Firewall (WAF).
bot_signatures_package (WebApplicationFirewallPackage) – Package containing bot signatures for the NGINX App Protect Web Application Firewall (WAF).
threat_campaigns_package (WebApplicationFirewallPackage) – Package containing threat campaigns for the NGINX App Protect Web Application Firewall (WAF).
component_versions (WebApplicationFirewallComponentVersions) – Versions of the NGINX App Protect Web Application Firewall (WAF) components.