@azure/arm-nginx package

Classes

NginxManagementClient

Interfaces

AnalysisCreate	The request body for creating an analysis for an NGINX configuration.
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
ApiKeys	Interface representing a ApiKeys.
ApiKeysCreateOrUpdateOptionalParams	Optional parameters.
ApiKeysDeleteOptionalParams	Optional parameters.
ApiKeysGetOptionalParams	Optional parameters.
ApiKeysListNextOptionalParams	Optional parameters.
ApiKeysListOptionalParams	Optional parameters.
AutoUpgradeProfile	Autoupgrade settings of a deployment.
Certificates	Interface representing a Certificates.
CertificatesCreateOrUpdateOptionalParams	Optional parameters.
CertificatesDeleteOptionalParams	Optional parameters.
CertificatesGetOptionalParams	Optional parameters.
CertificatesListNextOptionalParams	Optional parameters.
CertificatesListOptionalParams	Optional parameters.
Configurations	Interface representing a Configurations.
ConfigurationsAnalysisOptionalParams	Optional parameters.
ConfigurationsCreateOrUpdateOptionalParams	Optional parameters.
ConfigurationsDeleteOptionalParams	Optional parameters.
ConfigurationsGetOptionalParams	Optional parameters.
ConfigurationsListNextOptionalParams	Optional parameters.
ConfigurationsListOptionalParams	Optional parameters.
Deployments	Interface representing a Deployments.
DeploymentsCreateOrUpdateOptionalParams	Optional parameters.
DeploymentsDeleteOptionalParams	Optional parameters.
DeploymentsGetOptionalParams	Optional parameters.
DeploymentsListByResourceGroupNextOptionalParams	Optional parameters.
DeploymentsListByResourceGroupOptionalParams	Optional parameters.
DeploymentsListNextOptionalParams	Optional parameters.
DeploymentsListOptionalParams	Optional parameters.
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. (This also follows the OData error response format.).
IdentityProperties
NginxCertificate
NginxCertificateErrorResponseBody
NginxCertificateListResponse
NginxCertificateProperties
NginxConfigurationFile
NginxConfigurationListResponse	Response of a list operation.
NginxConfigurationPackage
NginxConfigurationProtectedFileRequest
NginxConfigurationProtectedFileResponse
NginxConfigurationRequest
NginxConfigurationRequestProperties
NginxConfigurationResponse
NginxConfigurationResponseProperties
NginxDeployment
NginxDeploymentApiKeyListResponse
NginxDeploymentApiKeyRequest
NginxDeploymentApiKeyRequestProperties
NginxDeploymentApiKeyResponse
NginxDeploymentApiKeyResponseProperties
NginxDeploymentListResponse
NginxDeploymentProperties
NginxDeploymentPropertiesNginxAppProtect	Settings for NGINX App Protect (NAP)
NginxDeploymentScalingProperties	Information on how the deployment will be scaled.
NginxDeploymentUpdateParameters
NginxDeploymentUpdateProperties
NginxDeploymentUpdatePropertiesNginxAppProtect	Update settings for NGINX App Protect (NAP)
NginxDeploymentUserProfile
NginxFrontendIPConfiguration
NginxLogging
NginxManagementClientOptionalParams	Optional parameters.
NginxNetworkInterfaceConfiguration
NginxNetworkProfile
NginxPrivateIPAddress
NginxPublicIPAddress
NginxStorageAccount
OperationDisplay	The object that represents the operation.
OperationListResult	Result of GET request to list Nginx.NginxPlus operations.
OperationResult	A Nginx.NginxPlus REST API operation.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
ResourceSku
ScaleProfile	The autoscale profile.
ScaleProfileCapacity	The capacity parameters of the profile.
SystemData	Metadata pertaining to creation and last modification of the resource.
UserIdentityProperties
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

ActivationState	Defines values for ActivationState. 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
ApiKeysCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ApiKeysGetResponse	Contains response data for the get operation.
ApiKeysListNextResponse	Contains response data for the listNext operation.
ApiKeysListResponse	Contains response data for the list operation.
CertificatesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
CertificatesGetResponse	Contains response data for the get operation.
CertificatesListNextResponse	Contains response data for the listNext operation.
CertificatesListResponse	Contains response data for the list operation.
ConfigurationsAnalysisResponse	Contains response data for the analysis operation.
ConfigurationsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ConfigurationsGetResponse	Contains response data for the get operation.
ConfigurationsListNextResponse	Contains response data for the listNext operation.
ConfigurationsListResponse	Contains response data for the list operation.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DeploymentsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DeploymentsGetResponse	Contains response data for the get operation.
DeploymentsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
DeploymentsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
DeploymentsListNextResponse	Contains response data for the listNext operation.
DeploymentsListResponse	Contains response data for the list operation.
DeploymentsUpdateResponse	Contains response data for the update operation.
IdentityType	Defines values for IdentityType. 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	Defines values for Level. 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
NginxPrivateIPAllocationMethod	Defines values for NginxPrivateIPAllocationMethod. 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
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
ProvisioningState	Defines values for ProvisioningState. 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

KnownActivationState	Known values of ActivationState that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownIdentityType	Known values of IdentityType that the service accepts.
KnownLevel	Known values of Level that the service accepts.
KnownNginxPrivateIPAllocationMethod	Known values of NginxPrivateIPAllocationMethod that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.