@azure/arm-nginx package

Classes

NginxManagementClient

Interfaces

AnalysisCreate	The request body for creating an analysis for an NGINX configuration.
AnalysisCreateConfig	model interface AnalysisCreateConfig
AnalysisDiagnostic	An error object found during the analysis of an NGINX configuration.
AnalysisResult	The response body for an analysis request. Contains the status of the analysis and any errors.
AnalysisResultData	model interface AnalysisResultData
ApiKeysCreateOrUpdateOptionalParams	Optional parameters.
ApiKeysDeleteOptionalParams	Optional parameters.
ApiKeysGetOptionalParams	Optional parameters.
ApiKeysListOptionalParams	Optional parameters.
ApiKeysOperations	Interface representing a ApiKeys operations.
AutoUpgradeProfile	Autoupgrade settings of a deployment.
CertificatesCreateOrUpdateOptionalParams	Optional parameters.
CertificatesDeleteOptionalParams	Optional parameters.
CertificatesGetOptionalParams	Optional parameters.
CertificatesListOptionalParams	Optional parameters.
CertificatesOperations	Interface representing a Certificates operations.
ConfigurationsAnalysisOptionalParams	Optional parameters.
ConfigurationsCreateOrUpdateOptionalParams	Optional parameters.
ConfigurationsDeleteOptionalParams	Optional parameters.
ConfigurationsGetOptionalParams	Optional parameters.
ConfigurationsListOptionalParams	Optional parameters.
ConfigurationsOperations	Interface representing a Configurations operations.
DefaultWafPolicyListOptionalParams	Optional parameters.
DefaultWafPolicyOperations	Interface representing a DefaultWafPolicy operations.
DeploymentsCreateOrUpdateOptionalParams	Optional parameters.
DeploymentsDeleteOptionalParams	Optional parameters.
DeploymentsGetOptionalParams	Optional parameters.
DeploymentsListByResourceGroupOptionalParams	Optional parameters.
DeploymentsListOptionalParams	Optional parameters.
DeploymentsOperations	Interface representing a Deployments operations.
DeploymentsUpdateOptionalParams	Optional parameters.
DiagnosticItem	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.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
IdentityProperties	Identity Properties
NginxCertificate	Nginx Certificate
NginxCertificateErrorResponseBody	Nginx Certificate Error Response Body
NginxCertificateProperties	Nginx Certificate Properties
NginxConfiguration	Nginx Configuration Response
NginxConfigurationFile	Nginx Configuration File
NginxConfigurationPackage	Nginx Configuration Package
NginxConfigurationProperties	Nginx Configuration Response Properties
NginxConfigurationProtectedFileRequest	Nginx Configuration Protected File Request
NginxConfigurationProtectedFileResponse	Nginx Configuration Protected File Response
NginxConfigurationRequest	Nginx Configuration Request
NginxConfigurationRequestProperties	Nginx Configuration Request Properties
NginxDeployment	Nginx Deployment
NginxDeploymentApiKeyRequest	Nginx Deployment Api Key Request
NginxDeploymentApiKeyRequestProperties	Nginx Deployment Api Key Request Properties
NginxDeploymentApiKeyResponse	Nginx Deployment Api Key Response
NginxDeploymentApiKeyResponseProperties	Nginx Deployment Api Key Response Properties
NginxDeploymentDefaultWafPolicyListResponse	Nginx Deployment Default Waf Policy List Response
NginxDeploymentDefaultWafPolicyProperties	Nginx Deployment Default Waf Policy Properties
NginxDeploymentProperties	Nginx Deployment Properties
NginxDeploymentPropertiesNginxAppProtect	Settings for NGINX App Protect (NAP)
NginxDeploymentScalingProperties	Information on how the deployment will be scaled.
NginxDeploymentScalingPropertiesAutoScaleSettings	The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty.
NginxDeploymentUpdateParameters	Nginx Deployment Update Parameters
NginxDeploymentUpdateProperties	Nginx Deployment Update Properties
NginxDeploymentUpdatePropertiesNginxAppProtect	Update settings for NGINX App Protect (NAP)
NginxDeploymentUserProfile	Nginx Deployment User Profile
NginxDeploymentWafPoliciesAnalysisOptionalParams	Optional parameters.
NginxDeploymentWafPoliciesOperations	Interface representing a NginxDeploymentWafPolicies operations.
NginxDeploymentWafPolicy	Nginx Deployment Waf Policy
NginxDeploymentWafPolicyAnalysisCreateRequest	Nginx Deployment Waf Policy Analysis Create Request
NginxDeploymentWafPolicyAnalysisData	Nginx Deployment Waf Policy Analysis Data
NginxDeploymentWafPolicyAnalysisResponse	Nginx Deployment Waf Policy Analysis Response
NginxDeploymentWafPolicyApplyingStatus	Nginx Deployment Waf Policy Applying Status
NginxDeploymentWafPolicyCompilingStatus	Nginx Deployment Waf Policy Compiling Status
NginxDeploymentWafPolicyError	Nginx Deployment Waf Policy Error
NginxDeploymentWafPolicyMetadata	Nginx Deployment Waf Policy Metadata
NginxDeploymentWafPolicyMetadataProperties	Nginx Deployment Waf Policy Metadata Properties
NginxDeploymentWafPolicyProperties	Nginx Deployment Waf Policy Properties
NginxFrontendIPConfiguration	Nginx Frontend IP Configuration
NginxLogging	Nginx Logging
NginxManagementClientOptionalParams	Optional parameters for the client.
NginxNetworkInterfaceConfiguration	Nginx Network Interface Configuration
NginxNetworkProfile	Nginx Network Profile
NginxPrivateIPAddress	Nginx Private IP Address
NginxPublicIPAddress	Nginx Public IP Address
NginxStorageAccount	Nginx Storage Account
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceSku	Resource Sku
RestorePollerOptions
ScaleProfile	The autoscale profile.
ScaleProfileCapacity	The capacity parameters of the profile.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserIdentityProperties	User Identity Properties
WafPolicyCreateOptionalParams	Optional parameters.
WafPolicyDeleteOptionalParams	Optional parameters.
WafPolicyGetOptionalParams	Optional parameters.
WafPolicyListOptionalParams	Optional parameters.
WafPolicyOperations	Interface representing a WafPolicy operations.
WebApplicationFirewallComponentVersions	Versions of the NGINX App Protect Web Application Firewall (WAF) components.
WebApplicationFirewallPackage	NGINX App Protect Web Application Firewall (WAF) Package. Contains the version and revision date of the package.
WebApplicationFirewallSettings	Settings for the NGINX App Protect Web Application Firewall (WAF)
WebApplicationFirewallStatus	The status of the NGINX App Protect Web Application Firewall

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
ActivationState	The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. KnownActivationState can be used interchangeably with ActivationState, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
IdentityType	Identity Type KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports. Known values supported by the service SystemAssigned UserAssigned SystemAssigned, UserAssigned None
Level	Warning or Info KnownLevel can be used interchangeably with Level, this enum contains the known values that the service supports. Known values supported by the service Info Warning
NginxDeploymentWafPolicyApplyingStatusCode	Machine readable code indicating the applying status code of a WAF Policy. KnownNginxDeploymentWafPolicyApplyingStatusCode can be used interchangeably with NginxDeploymentWafPolicyApplyingStatusCode, this enum contains the known values that the service supports. Known values supported by the service NotApplied: The policy is not referenced in the nginx config and not applied. Applying: The policy is referenced in the nginx config and is applying. Succeeded: The policy is referenced in the nginx config and that config has been successfully applied. Failed: The policy is referenced in the nginx config and that config failed to apply. Removing: The policy is now not referenced in the nginx config and its being removed from the applied nginx config.
NginxDeploymentWafPolicyCompilingStatusCode	Machine readable code indicating the compilation status of a WAF Policy. KnownNginxDeploymentWafPolicyCompilingStatusCode can be used interchangeably with NginxDeploymentWafPolicyCompilingStatusCode, this enum contains the known values that the service supports. Known values supported by the service NotStarted: The compilation of the custom waf policy has not started InProgress: The compilation of the custom waf policy is in progress Succeeded: The compilation of the custom waf policy is completed successfully and can now be referenced in the nginx config. Failed: The compilation of the custom waf policy failed.
NginxPrivateIPAllocationMethod	Nginx Private IP Allocation Method KnownNginxPrivateIPAllocationMethod can be used interchangeably with NginxPrivateIPAllocationMethod, this enum contains the known values that the service supports. Known values supported by the service Static Dynamic
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
ProvisioningState	Provisioning State KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Accepted Creating Updating Deleting Succeeded Failed Canceled Deleted NotSpecified

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActivationState	The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it.
KnownCreatedByType	The kind of entity that created the resource.
KnownIdentityType	Identity Type
KnownLevel	Warning or Info
KnownNginxDeploymentWafPolicyApplyingStatusCode	Machine readable code indicating the applying status code of a WAF Policy.
KnownNginxDeploymentWafPolicyCompilingStatusCode	Machine readable code indicating the compilation status of a WAF Policy.
KnownNginxPrivateIPAllocationMethod	Nginx Private IP Allocation Method
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProvisioningState	Provisioning State
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(NginxManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(NginxManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: NginxManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

NginxManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>