@azure/arm-nginx package

类

NginxManagementClient

接口

AnalysisCreate	用于为 NGINX 配置创建分析的请求正文。
AnalysisCreateConfig	model interface AnalysisCreateConfig
AnalysisDiagnostic	在分析NGINX配置时发现的错误对象。
AnalysisResult	分析请求的回复体。 包含分析状态及任何错误。
AnalysisResultData	模型接口分析结果数据
ApiKeysCreateOrUpdateOptionalParams	可选参数。
ApiKeysDeleteOptionalParams	可选参数。
ApiKeysGetOptionalParams	可选参数。
ApiKeysListOptionalParams	可选参数。
ApiKeysOperations	表示ApiKey操作的接口。
AutoUpgradeProfile	部署的自动升级设置。
CertificatesCreateOrUpdateOptionalParams	可选参数。
CertificatesDeleteOptionalParams	可选参数。
CertificatesGetOptionalParams	可选参数。
CertificatesListOptionalParams	可选参数。
CertificatesOperations	表示证书操作的接口。
ConfigurationsAnalysisOptionalParams	可选参数。
ConfigurationsCreateOrUpdateOptionalParams	可选参数。
ConfigurationsDeleteOptionalParams	可选参数。
ConfigurationsGetOptionalParams	可选参数。
ConfigurationsListOptionalParams	可选参数。
ConfigurationsOperations	表示配置操作的接口。
DefaultWafPolicyListOptionalParams	可选参数。
DefaultWafPolicyOperations	表示 DefaultWafPolicy 操作的接口。
DeploymentsCreateOrUpdateOptionalParams	可选参数。
DeploymentsDeleteOptionalParams	可选参数。
DeploymentsGetOptionalParams	可选参数。
DeploymentsListByResourceGroupOptionalParams	可选参数。
DeploymentsListOptionalParams	可选参数。
DeploymentsOperations	表示 Deployment作的接口。
DeploymentsUpdateOptionalParams	可选参数。
DiagnosticItem	诊断是与NGINX配置相关的消息。分析仪返回诊断数据，并带有一个等级，显示诊断的重要性，并可选类别。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	所有 Azure 资源管理器 API 的常见错误响应，以返回失败作的错误详细信息。
IdentityProperties	标识属性
NginxCertificate	Nginx证书
NginxCertificateErrorResponseBody	Nginx 证书错误响应正文
NginxCertificateProperties	Nginx 证书属性
NginxConfiguration	Nginx 配置响应
NginxConfigurationFile	Nginx 配置文件
NginxConfigurationPackage	Nginx 配置包
NginxConfigurationProperties	Nginx 配置响应属性
NginxConfigurationProtectedFileRequest	Nginx 配置保护文件请求
NginxConfigurationProtectedFileResponse	Nginx 配置保护文件响应
NginxConfigurationRequest	Nginx 配置请求
NginxConfigurationRequestProperties	Nginx 配置请求属性
NginxDeployment	Nginx 部署
NginxDeploymentApiKeyRequest	Nginx 部署 API 密钥请求
NginxDeploymentApiKeyRequestProperties	Nginx 部署 API 密钥请求属性
NginxDeploymentApiKeyResponse	Nginx 部署 API 密钥响应
NginxDeploymentApiKeyResponseProperties	Nginx 部署 API 密钥响应属性
NginxDeploymentDefaultWafPolicyListResponse	Nginx 部署默认 Waf 策略列表响应
NginxDeploymentDefaultWafPolicyProperties	Nginx 部署默认 Waf 策略属性
NginxDeploymentProperties	Nginx 部署属性
NginxDeploymentPropertiesNginxAppProtect	NGINX 应用保护的设置（NAP）
NginxDeploymentScalingProperties	有关如何缩放部署的信息。
NginxDeploymentScalingPropertiesAutoScaleSettings	启用部署自动缩放的设置。 如果指定此字段，则“scale.capacity”必须为空。
NginxDeploymentUpdateParameters	Nginx 部署更新参数
NginxDeploymentUpdateProperties	Nginx 部署更新属性
NginxDeploymentUpdatePropertiesNginxAppProtect	更新NGINX App Protect（NAP）设置
NginxDeploymentUserProfile	Nginx 部署用户配置文件
NginxDeploymentWafPoliciesAnalysisOptionalParams	可选参数。
NginxDeploymentWafPoliciesOperations	表示 NginxDeploymentWafPolicies 操作的接口。
NginxDeploymentWafPolicy	Nginx 部署 Waf 政策
NginxDeploymentWafPolicyAnalysisCreateRequest	Nginx 部署 Waf 策略分析 创建请求
NginxDeploymentWafPolicyAnalysisData	Nginx 部署 Waf 策略分析数据
NginxDeploymentWafPolicyAnalysisResponse	Nginx 部署 Waf 策略分析响应
NginxDeploymentWafPolicyApplyingStatus	Nginx 部署 Waf 策略应用状态
NginxDeploymentWafPolicyCompilingStatus	Nginx 部署 Waf 策略编译状态
NginxDeploymentWafPolicyError	Nginx 部署 Waf 策略错误
NginxDeploymentWafPolicyMetadata	Nginx 部署 Waf 策略元数据
NginxDeploymentWafPolicyMetadataProperties	Nginx 部署 Waf 策略元数据属性
NginxDeploymentWafPolicyProperties	Nginx 部署 Waf 策略属性
NginxFrontendIPConfiguration	Nginx 前端 IP 配置
NginxLogging	Nginx 日志记录
NginxManagementClientOptionalParams	客户端的可选参数。
NginxNetworkInterfaceConfiguration	Nginx 网络接口配置
NginxNetworkProfile	Nginx 网络简介
NginxPrivateIPAddress	Nginx 私有 IP 地址
NginxPublicIPAddress	Nginx 公共 IP 地址
NginxStorageAccount	Nginx 存储帐户
Operation	从资源提供程序操作 API 返回的 REST API 操作的详细信息
OperationDisplay	作的局部显示信息。
OperationsListOptionalParams	可选参数。
OperationsOperations	表示操作操作的接口。
PageSettings	byPage 方法的选项
PagedAsyncIterableIterator	允许异步迭代到完成和逐页迭代的接口。
ProxyResource	Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置
Resource	所有 Azure 资源管理器资源的响应中返回的常见字段
ResourceSku	资源SKU
RestorePollerOptions
ScaleProfile	自动比例配置文件。
ScaleProfileCapacity	配置文件的容量参数。
SimplePollerLike	可用于轮询长时间运行的操作的简单轮询程序。
SystemData	与创建和上次修改资源相关的元数据。
TrackedResource	Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源
UserIdentityProperties	用户身份属性
WafPolicyCreateOptionalParams	可选参数。
WafPolicyDeleteOptionalParams	可选参数。
WafPolicyGetOptionalParams	可选参数。
WafPolicyListOptionalParams	可选参数。
WafPolicyOperations	表示WafPolicy操作的接口。
WebApplicationFirewallComponentVersions	NGINX 应用保护网络应用防火墙（WAF）组件的版本。
WebApplicationFirewallPackage	NGINX 应用保护网络应用防火墙（WAF）包。 包含软件包的版本和修订日期。
WebApplicationFirewallSettings	NGINX 应用保护 Web 应用程序防火墙（WAF）的设置
WebApplicationFirewallStatus	NGINX 应用保护网络应用防火墙的状态

类型别名

ActionType	可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。 KnownActionType 可与 ActionType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 内部：作适用于仅限内部的 API。
ActivationState	WAF 的激活状态。 使用“Enabled”启用 WAF 和“Disabled”将其禁用。 KnownActivationState 可以与 ActivationState 互换使用，该枚举包含服务支持的已知值。 服务支持的已知值 已启用 已禁用
AzureSupportedClouds	云设置为字符串文字类型的支持值
ContinuablePage	描述结果页的接口。
CreatedByType	创建资源的实体类型。 KnownCreatedByType 可与 CreatedByType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 用户：实体是由用户创建的。 应用程序：实体是由应用程序创建的。 ManagedIdentity：实体是由托管标识创建的。 密钥：实体是由密钥创建的。
IdentityType	身份类型 KnownIdentityType 可与 IdentityType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 SystemAssigned UserAssigned SystemAssigned、UserAssigned 无
Level	警告或信息 KnownLevel 可与 Level 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 信息 警告
NginxDeploymentWafPolicyApplyingStatusCode	机器可读代码，表示WAF策略的应用状态代码。 KnownNginxDeploymentWafPolicyApplyingStatusCode 可以与 NginxDeploymentWafPolicyApplyingStatusCode 互换使用，该枚举包含服务支持的已知值。 服务支持的已知值 未应用：该策略未在nginx配置中引用，也未应用。 应用：该策略在nginx配置中被引用，正在应用中。 成功：该策略在nginx配置中被引用，且该配置已成功应用。 失败：该策略在nginx配置中被引用，但该配置未能应用。 移除：该策略现在不再出现在nginx配置中，并且从已应用的nginx配置中移除。
NginxDeploymentWafPolicyCompilingStatusCode	机器可读代码，表示WAF策略的编译状态。 KnownNginxDeploymentWafPolicyCompilingStatusCode 可以与 NginxDeploymentWafPolicyCompilingStatusCode 互换使用，该枚举包含服务支持的已知值。 服务支持的已知值 NotStarted：自定义WAF策略的编译尚未开始 正在进行中：定制WAF政策正在编制中 成功：自定义 waf 策略的编译已成功完成，现在可以在 nginx 配置中引用。 失败：自定义WAF策略的编译失败。
NginxPrivateIPAllocationMethod	Nginx 私有 IP 分配方法 KnownNginxPrivateIPAllocationMethod 可与 NginxPrivateIPAllocationMethod 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 静态 动态
Origin	操作的预期执行程序;与基于资源的访问控制 （RBAC） 和审核日志 UX 中一样。 默认值为“user，system” KnownOrigin 可与 Origin 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 用户：指示作是由用户启动的。 系统：指示作是由系统启动的。 用户，系统：指示作是由用户或系统启动的。
ProvisioningState	配置状态 KnownProvisioningState 可与 ProvisioningState 互换，此枚举包含服务支持的已知值。 服务支持的已知值 已接受 创建 更新 删除 已成功 失败 已取消 已删除 NotSpecified

枚举

AzureClouds	用于描述 Azure 云环境的枚举。
KnownActionType	可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。
KnownActivationState	WAF 的激活状态。 使用“Enabled”启用 WAF 和“Disabled”将其禁用。
KnownCreatedByType	创建资源的实体类型。
KnownIdentityType	标识类型
KnownLevel	警告或信息
KnownNginxDeploymentWafPolicyApplyingStatusCode	机器可读代码，表示WAF策略的应用状态代码。
KnownNginxDeploymentWafPolicyCompilingStatusCode	机器可读代码，表示WAF策略的编译状态。
KnownNginxPrivateIPAllocationMethod	Nginx 私有 IP 分配方式
KnownOrigin	操作的预期执行程序;与基于资源的访问控制 （RBAC） 和审核日志 UX 中一样。 默认值为“user，system”
KnownProvisioningState	预配状态
KnownVersions	可用的 API 版本。

函数

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

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器，或者在原始轮询器不在范围内后构造轮询器，这非常有用。

函数详细信息

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

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器，或者在原始轮询器不在范围内后构造轮询器，这非常有用。

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

参数

client

NginxManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

返回

PollerLike<OperationState<TResult>, TResult>