NGINX.NGINXPLUS (preview:2025-03-01)

2025/07/10 • 27 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/NGINX.NGINXPLUS/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
NginxDeployments_ListBySubscription (new)
Description :  Lists all Nginx deployments in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/NGINX.NGINXPLUS/nginxDeployments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NginxDeployment items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the deployment. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Description: The Nginx version. ,
Required: True ,
}
string ,
networkProfile:
{
Description: The network profile. ,
Required: True ,
}
{
frontEndIPConfiguration:
{
Description: Frontend IP configuration. ,
Required: True ,
}
{
publicIPAddresses:
{
Description: Public IP addresses. ,
Required: True ,
}
[
{
id:
{
Description: The resource ID of the public IP address. ,
Required: True ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Description: Private IP addresses. ,
Required: True ,
}
[
{
privateIPAddress:
{
Description: The private IP address. ,
Required: True ,
}
string ,
privateIPAllocationMethod:
{
Description: The allocation method for the private IP. ,
Enum:
{
Static: Static private IP allocation method. ,
Dynamic: Dynamic private IP allocation method. ,
}
,
Required: True ,
}
enum ,
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Description: Network interface configuration. ,
Required: True ,
}
{
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: True ,
}
string ,
enableDiagnosticsSupport:
{
Description: Whether diagnostics support is enabled. ,
Required: True ,
}
boolean ,
logging:
{
Description: Logging configuration. ,
Required: True ,
}
{
storageAccount:
{
Description: Storage account configuration. ,
Required: True ,
}
{
accountName:
{
Description: The storage account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Scaling properties. ,
Required: True ,
}
{
capacity:
{
Description: The capacity of the deployment. ,
Format: int32 ,
Required: True ,
}
integer ,
autoScaleSettings:
{
Description: Auto-scale settings. ,
Required: True ,
}
{
profiles:
{
Description: List of scale profiles. ,
Required: True ,
}
[
{
name:
{
Description: The name of the scale profile. ,
Required: True ,
}
string ,
capacity:
{
Description: Capacity settings for the scale profile. ,
Required: True ,
}
{
min:
{
Description: Minimum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Auto-upgrade profile. ,
Required: True ,
}
{
upgradeChannel:
{
Description: The upgrade channel. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Description: User profile. ,
Required: True ,
}
{
preferredEmail:
{
Description: The preferred email address. ,
Required: True ,
}
string ,
}
,
nginxAppProtect:
{
Description: Nginx App Protect configuration. ,
Required: True ,
}
{
webApplicationFirewallSettings:
{
Description: Web application firewall settings. ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. ,
Enum:
{
Enabled: WAF is enabled. ,
Disabled: WAF is disabled. ,
}
,
Required: True ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: Web application firewall status. ,
Required: True ,
}
{
wafRelease:
{
Description: The WAF release version. ,
Required: True ,
}
string ,
attackSignaturesPackage:
{
Description: Attack signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Bot signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Threat campaigns package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Component versions. ,
Required: True ,
}
{
wafEngineVersion:
{
Description: WAF engine version. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: WAF Nginx version. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
NginxDeployments_ListByResourceGroup (new)
Description :  Lists all Nginx deployments in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The NginxDeployment items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the deployment. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Description: The Nginx version. ,
Required: True ,
}
string ,
networkProfile:
{
Description: The network profile. ,
Required: True ,
}
{
frontEndIPConfiguration:
{
Description: Frontend IP configuration. ,
Required: True ,
}
{
publicIPAddresses:
{
Description: Public IP addresses. ,
Required: True ,
}
[
{
id:
{
Description: The resource ID of the public IP address. ,
Required: True ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Description: Private IP addresses. ,
Required: True ,
}
[
{
privateIPAddress:
{
Description: The private IP address. ,
Required: True ,
}
string ,
privateIPAllocationMethod:
{
Description: The allocation method for the private IP. ,
Enum:
{
Static: Static private IP allocation method. ,
Dynamic: Dynamic private IP allocation method. ,
}
,
Required: True ,
}
enum ,
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Description: Network interface configuration. ,
Required: True ,
}
{
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: True ,
}
string ,
enableDiagnosticsSupport:
{
Description: Whether diagnostics support is enabled. ,
Required: True ,
}
boolean ,
logging:
{
Description: Logging configuration. ,
Required: True ,
}
{
storageAccount:
{
Description: Storage account configuration. ,
Required: True ,
}
{
accountName:
{
Description: The storage account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Scaling properties. ,
Required: True ,
}
{
capacity:
{
Description: The capacity of the deployment. ,
Format: int32 ,
Required: True ,
}
integer ,
autoScaleSettings:
{
Description: Auto-scale settings. ,
Required: True ,
}
{
profiles:
{
Description: List of scale profiles. ,
Required: True ,
}
[
{
name:
{
Description: The name of the scale profile. ,
Required: True ,
}
string ,
capacity:
{
Description: Capacity settings for the scale profile. ,
Required: True ,
}
{
min:
{
Description: Minimum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Auto-upgrade profile. ,
Required: True ,
}
{
upgradeChannel:
{
Description: The upgrade channel. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Description: User profile. ,
Required: True ,
}
{
preferredEmail:
{
Description: The preferred email address. ,
Required: True ,
}
string ,
}
,
nginxAppProtect:
{
Description: Nginx App Protect configuration. ,
Required: True ,
}
{
webApplicationFirewallSettings:
{
Description: Web application firewall settings. ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. ,
Enum:
{
Enabled: WAF is enabled. ,
Disabled: WAF is disabled. ,
}
,
Required: True ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: Web application firewall status. ,
Required: True ,
}
{
wafRelease:
{
Description: The WAF release version. ,
Required: True ,
}
string ,
attackSignaturesPackage:
{
Description: Attack signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Bot signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Threat campaigns package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Component versions. ,
Required: True ,
}
{
wafEngineVersion:
{
Description: WAF engine version. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: WAF Nginx version. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
NginxDeployments_Get (new)
Description :  Gets the properties of a specific Nginx deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the deployment. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Description: The Nginx version. ,
Required: True ,
}
string ,
networkProfile:
{
Description: The network profile. ,
Required: True ,
}
{
frontEndIPConfiguration:
{
Description: Frontend IP configuration. ,
Required: True ,
}
{
publicIPAddresses:
{
Description: Public IP addresses. ,
Required: True ,
}
[
{
id:
{
Description: The resource ID of the public IP address. ,
Required: True ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Description: Private IP addresses. ,
Required: True ,
}
[
{
privateIPAddress:
{
Description: The private IP address. ,
Required: True ,
}
string ,
privateIPAllocationMethod:
{
Description: The allocation method for the private IP. ,
Enum:
{
Static: Static private IP allocation method. ,
Dynamic: Dynamic private IP allocation method. ,
}
,
Required: True ,
}
enum ,
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Description: Network interface configuration. ,
Required: True ,
}
{
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: True ,
}
string ,
enableDiagnosticsSupport:
{
Description: Whether diagnostics support is enabled. ,
Required: True ,
}
boolean ,
logging:
{
Description: Logging configuration. ,
Required: True ,
}
{
storageAccount:
{
Description: Storage account configuration. ,
Required: True ,
}
{
accountName:
{
Description: The storage account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Scaling properties. ,
Required: True ,
}
{
capacity:
{
Description: The capacity of the deployment. ,
Format: int32 ,
Required: True ,
}
integer ,
autoScaleSettings:
{
Description: Auto-scale settings. ,
Required: True ,
}
{
profiles:
{
Description: List of scale profiles. ,
Required: True ,
}
[
{
name:
{
Description: The name of the scale profile. ,
Required: True ,
}
string ,
capacity:
{
Description: Capacity settings for the scale profile. ,
Required: True ,
}
{
min:
{
Description: Minimum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Auto-upgrade profile. ,
Required: True ,
}
{
upgradeChannel:
{
Description: The upgrade channel. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Description: User profile. ,
Required: True ,
}
{
preferredEmail:
{
Description: The preferred email address. ,
Required: True ,
}
string ,
}
,
nginxAppProtect:
{
Description: Nginx App Protect configuration. ,
Required: True ,
}
{
webApplicationFirewallSettings:
{
Description: Web application firewall settings. ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. ,
Enum:
{
Enabled: WAF is enabled. ,
Disabled: WAF is disabled. ,
}
,
Required: True ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: Web application firewall status. ,
Required: True ,
}
{
wafRelease:
{
Description: The WAF release version. ,
Required: True ,
}
string ,
attackSignaturesPackage:
{
Description: Attack signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Bot signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Threat campaigns package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Component versions. ,
Required: True ,
}
{
wafEngineVersion:
{
Description: WAF engine version. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: WAF Nginx version. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
NginxDeployments_CreateOrUpdate (new)
Description :  Creates or updates an Nginx deployment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the deployment. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Description: The Nginx version. ,
Required: True ,
}
string ,
networkProfile:
{
Description: The network profile. ,
Required: True ,
}
{
frontEndIPConfiguration:
{
Description: Frontend IP configuration. ,
Required: True ,
}
{
publicIPAddresses:
{
Description: Public IP addresses. ,
Required: True ,
}
[
{
id:
{
Description: The resource ID of the public IP address. ,
Required: True ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Description: Private IP addresses. ,
Required: True ,
}
[
{
privateIPAddress:
{
Description: The private IP address. ,
Required: True ,
}
string ,
privateIPAllocationMethod:
{
Description: The allocation method for the private IP. ,
Enum:
{
Static: Static private IP allocation method. ,
Dynamic: Dynamic private IP allocation method. ,
}
,
Required: True ,
}
enum ,
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Description: Network interface configuration. ,
Required: True ,
}
{
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: True ,
}
string ,
enableDiagnosticsSupport:
{
Description: Whether diagnostics support is enabled. ,
Required: True ,
}
boolean ,
logging:
{
Description: Logging configuration. ,
Required: True ,
}
{
storageAccount:
{
Description: Storage account configuration. ,
Required: True ,
}
{
accountName:
{
Description: The storage account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Scaling properties. ,
Required: True ,
}
{
capacity:
{
Description: The capacity of the deployment. ,
Format: int32 ,
Required: True ,
}
integer ,
autoScaleSettings:
{
Description: Auto-scale settings. ,
Required: True ,
}
{
profiles:
{
Description: List of scale profiles. ,
Required: True ,
}
[
{
name:
{
Description: The name of the scale profile. ,
Required: True ,
}
string ,
capacity:
{
Description: Capacity settings for the scale profile. ,
Required: True ,
}
{
min:
{
Description: Minimum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Auto-upgrade profile. ,
Required: True ,
}
{
upgradeChannel:
{
Description: The upgrade channel. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Description: User profile. ,
Required: True ,
}
{
preferredEmail:
{
Description: The preferred email address. ,
Required: True ,
}
string ,
}
,
nginxAppProtect:
{
Description: Nginx App Protect configuration. ,
Required: True ,
}
{
webApplicationFirewallSettings:
{
Description: Web application firewall settings. ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. ,
Enum:
{
Enabled: WAF is enabled. ,
Disabled: WAF is disabled. ,
}
,
Required: True ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: Web application firewall status. ,
Required: True ,
}
{
wafRelease:
{
Description: The WAF release version. ,
Required: True ,
}
string ,
attackSignaturesPackage:
{
Description: Attack signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Bot signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Threat campaigns package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Component versions. ,
Required: True ,
}
{
wafEngineVersion:
{
Description: WAF engine version. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: WAF Nginx version. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the deployment. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Description: The Nginx version. ,
Required: True ,
}
string ,
networkProfile:
{
Description: The network profile. ,
Required: True ,
}
{
frontEndIPConfiguration:
{
Description: Frontend IP configuration. ,
Required: True ,
}
{
publicIPAddresses:
{
Description: Public IP addresses. ,
Required: True ,
}
[
{
id:
{
Description: The resource ID of the public IP address. ,
Required: True ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Description: Private IP addresses. ,
Required: True ,
}
[
{
privateIPAddress:
{
Description: The private IP address. ,
Required: True ,
}
string ,
privateIPAllocationMethod:
{
Description: The allocation method for the private IP. ,
Enum:
{
Static: Static private IP allocation method. ,
Dynamic: Dynamic private IP allocation method. ,
}
,
Required: True ,
}
enum ,
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Description: Network interface configuration. ,
Required: True ,
}
{
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: True ,
}
string ,
enableDiagnosticsSupport:
{
Description: Whether diagnostics support is enabled. ,
Required: True ,
}
boolean ,
logging:
{
Description: Logging configuration. ,
Required: True ,
}
{
storageAccount:
{
Description: Storage account configuration. ,
Required: True ,
}
{
accountName:
{
Description: The storage account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Scaling properties. ,
Required: True ,
}
{
capacity:
{
Description: The capacity of the deployment. ,
Format: int32 ,
Required: True ,
}
integer ,
autoScaleSettings:
{
Description: Auto-scale settings. ,
Required: True ,
}
{
profiles:
{
Description: List of scale profiles. ,
Required: True ,
}
[
{
name:
{
Description: The name of the scale profile. ,
Required: True ,
}
string ,
capacity:
{
Description: Capacity settings for the scale profile. ,
Required: True ,
}
{
min:
{
Description: Minimum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Auto-upgrade profile. ,
Required: True ,
}
{
upgradeChannel:
{
Description: The upgrade channel. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Description: User profile. ,
Required: True ,
}
{
preferredEmail:
{
Description: The preferred email address. ,
Required: True ,
}
string ,
}
,
nginxAppProtect:
{
Description: Nginx App Protect configuration. ,
Required: True ,
}
{
webApplicationFirewallSettings:
{
Description: Web application firewall settings. ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. ,
Enum:
{
Enabled: WAF is enabled. ,
Disabled: WAF is disabled. ,
}
,
Required: True ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: Web application firewall status. ,
Required: True ,
}
{
wafRelease:
{
Description: The WAF release version. ,
Required: True ,
}
string ,
attackSignaturesPackage:
{
Description: Attack signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Bot signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Threat campaigns package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Component versions. ,
Required: True ,
}
{
wafEngineVersion:
{
Description: WAF engine version. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: WAF Nginx version. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Represents an Nginx deployment resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the deployment. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Description: The Nginx version. ,
Required: True ,
}
string ,
networkProfile:
{
Description: The network profile. ,
Required: True ,
}
{
frontEndIPConfiguration:
{
Description: Frontend IP configuration. ,
Required: True ,
}
{
publicIPAddresses:
{
Description: Public IP addresses. ,
Required: True ,
}
[
{
id:
{
Description: The resource ID of the public IP address. ,
Required: True ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Description: Private IP addresses. ,
Required: True ,
}
[
{
privateIPAddress:
{
Description: The private IP address. ,
Required: True ,
}
string ,
privateIPAllocationMethod:
{
Description: The allocation method for the private IP. ,
Enum:
{
Static: Static private IP allocation method. ,
Dynamic: Dynamic private IP allocation method. ,
}
,
Required: True ,
}
enum ,
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Description: Network interface configuration. ,
Required: True ,
}
{
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: True ,
}
string ,
enableDiagnosticsSupport:
{
Description: Whether diagnostics support is enabled. ,
Required: True ,
}
boolean ,
logging:
{
Description: Logging configuration. ,
Required: True ,
}
{
storageAccount:
{
Description: Storage account configuration. ,
Required: True ,
}
{
accountName:
{
Description: The storage account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Scaling properties. ,
Required: True ,
}
{
capacity:
{
Description: The capacity of the deployment. ,
Format: int32 ,
Required: True ,
}
integer ,
autoScaleSettings:
{
Description: Auto-scale settings. ,
Required: True ,
}
{
profiles:
{
Description: List of scale profiles. ,
Required: True ,
}
[
{
name:
{
Description: The name of the scale profile. ,
Required: True ,
}
string ,
capacity:
{
Description: Capacity settings for the scale profile. ,
Required: True ,
}
{
min:
{
Description: Minimum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Auto-upgrade profile. ,
Required: True ,
}
{
upgradeChannel:
{
Description: The upgrade channel. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Description: User profile. ,
Required: True ,
}
{
preferredEmail:
{
Description: The preferred email address. ,
Required: True ,
}
string ,
}
,
nginxAppProtect:
{
Description: Nginx App Protect configuration. ,
Required: True ,
}
{
webApplicationFirewallSettings:
{
Description: Web application firewall settings. ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. ,
Enum:
{
Enabled: WAF is enabled. ,
Disabled: WAF is disabled. ,
}
,
Required: True ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: Web application firewall status. ,
Required: True ,
}
{
wafRelease:
{
Description: The WAF release version. ,
Required: True ,
}
string ,
attackSignaturesPackage:
{
Description: Attack signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Bot signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Threat campaigns package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Component versions. ,
Required: True ,
}
{
wafEngineVersion:
{
Description: WAF engine version. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: WAF Nginx version. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
NginxDeployments_Update (new)
Description :  Updates an Nginx deployment with patch semantics.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity assigned to this resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The identities assigned to this resource by the user. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: False ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
nginxVersion:
{
Description: The Nginx version. ,
Required: False ,
}
string ,
networkProfile:
{
Description: The network profile. ,
Required: False ,
}
{
frontEndIPConfiguration:
{
Description: Frontend IP configuration. ,
Required: False ,
}
{
publicIPAddresses:
{
Description: Public IP addresses. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID of the public IP address. ,
Required: True ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Description: Private IP addresses. ,
Required: False ,
}
[
{
privateIPAddress:
{
Description: The private IP address. ,
Required: True ,
}
string ,
privateIPAllocationMethod:
{
Description: The allocation method for the private IP. ,
Enum:
{
Static: Static private IP allocation method. ,
Dynamic: Dynamic private IP allocation method. ,
}
,
Required: True ,
}
enum ,
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Description: Network interface configuration. ,
Required: False ,
}
{
subnetId:
{
Description: The subnet resource ID. ,
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Description: Whether diagnostics support is enabled. ,
Required: False ,
}
boolean ,
logging:
{
Description: Logging configuration. ,
Required: False ,
}
{
storageAccount:
{
Description: Storage account configuration. ,
Required: False ,
}
{
accountName:
{
Description: The storage account name. ,
Required: False ,
}
string ,
containerName:
{
Description: The container name. ,
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Scaling properties. ,
Required: False ,
}
{
capacity:
{
Description: The capacity of the deployment. ,
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: Auto-scale settings. ,
Required: False ,
}
{
profiles:
{
Description: List of scale profiles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scale profile. ,
Required: True ,
}
string ,
capacity:
{
Description: Capacity settings for the scale profile. ,
Required: True ,
}
{
min:
{
Description: Minimum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Auto-upgrade profile. ,
Required: False ,
}
{
upgradeChannel:
{
Description: The upgrade channel. ,
Required: False ,
}
string ,
}
,
userProfile:
{
Description: User profile. ,
Required: False ,
}
{
preferredEmail:
{
Description: The preferred email address. ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Nginx App Protect configuration. ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Web application firewall settings. ,
Required: False ,
}
{
activationState:
{
Description: The activation state of the WAF. ,
Enum:
{
Enabled: WAF is enabled. ,
Disabled: WAF is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: Web application firewall status. ,
Required: False ,
}
{
wafRelease:
{
Description: The WAF release version. ,
Required: False ,
}
string ,
attackSignaturesPackage:
{
Description: Attack signatures package. ,
Required: False ,
}
{
version:
{
Description: The package version. ,
Required: False ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: False ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Bot signatures package. ,
Required: False ,
}
{
version:
{
Description: The package version. ,
Required: False ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: False ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Threat campaigns package. ,
Required: False ,
}
{
version:
{
Description: The package version. ,
Required: False ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: False ,
}
string ,
}
,
componentVersions:
{
Description: Component versions. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: WAF engine version. ,
Required: False ,
}
string ,
wafNginxVersion:
{
Description: WAF Nginx version. ,
Required: False ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the deployment. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Description: The Nginx version. ,
Required: True ,
}
string ,
networkProfile:
{
Description: The network profile. ,
Required: True ,
}
{
frontEndIPConfiguration:
{
Description: Frontend IP configuration. ,
Required: True ,
}
{
publicIPAddresses:
{
Description: Public IP addresses. ,
Required: True ,
}
[
{
id:
{
Description: The resource ID of the public IP address. ,
Required: True ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Description: Private IP addresses. ,
Required: True ,
}
[
{
privateIPAddress:
{
Description: The private IP address. ,
Required: True ,
}
string ,
privateIPAllocationMethod:
{
Description: The allocation method for the private IP. ,
Enum:
{
Static: Static private IP allocation method. ,
Dynamic: Dynamic private IP allocation method. ,
}
,
Required: True ,
}
enum ,
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Description: Network interface configuration. ,
Required: True ,
}
{
subnetId:
{
Description: The subnet resource ID. ,
Required: True ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: True ,
}
string ,
enableDiagnosticsSupport:
{
Description: Whether diagnostics support is enabled. ,
Required: True ,
}
boolean ,
logging:
{
Description: Logging configuration. ,
Required: True ,
}
{
storageAccount:
{
Description: Storage account configuration. ,
Required: True ,
}
{
accountName:
{
Description: The storage account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Scaling properties. ,
Required: True ,
}
{
capacity:
{
Description: The capacity of the deployment. ,
Format: int32 ,
Required: True ,
}
integer ,
autoScaleSettings:
{
Description: Auto-scale settings. ,
Required: True ,
}
{
profiles:
{
Description: List of scale profiles. ,
Required: True ,
}
[
{
name:
{
Description: The name of the scale profile. ,
Required: True ,
}
string ,
capacity:
{
Description: Capacity settings for the scale profile. ,
Required: True ,
}
{
min:
{
Description: Minimum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: Maximum capacity. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Auto-upgrade profile. ,
Required: True ,
}
{
upgradeChannel:
{
Description: The upgrade channel. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Description: User profile. ,
Required: True ,
}
{
preferredEmail:
{
Description: The preferred email address. ,
Required: True ,
}
string ,
}
,
nginxAppProtect:
{
Description: Nginx App Protect configuration. ,
Required: True ,
}
{
webApplicationFirewallSettings:
{
Description: Web application firewall settings. ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. ,
Enum:
{
Enabled: WAF is enabled. ,
Disabled: WAF is disabled. ,
}
,
Required: True ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: Web application firewall status. ,
Required: True ,
}
{
wafRelease:
{
Description: The WAF release version. ,
Required: True ,
}
string ,
attackSignaturesPackage:
{
Description: Attack signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Bot signatures package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Threat campaigns package. ,
Required: True ,
}
{
version:
{
Description: The package version. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The revision datetime. ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Component versions. ,
Required: True ,
}
{
wafEngineVersion:
{
Description: WAF engine version. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: WAF Nginx version. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
NginxDeployments_Delete (new)
Description :  Deletes a specific Nginx deployment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ApiKeys_ListByDeployment (new)
Description :  Lists all API keys under the specified Nginx deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/apiKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ApiKey items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hint:
{
Description: This is the name of the API key. ,
Required: True ,
}
string ,
endDateTime:
{
Description: Expiry of the key in UTC date-time format. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
ApiKeys_Get (new)
Description :  Retrieves the properties of a specific API key.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/apiKeys/{apiKeyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
apiKeyName:
{
Description: The name of the API Key resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hint:
{
Description: This is the name of the API key. ,
Required: True ,
}
string ,
endDateTime:
{
Description: Expiry of the key in UTC date-time format. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
ApiKeys_CreateOrUpdate (new)
Description :  Creates a new API key or replaces an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/apiKeys/{apiKeyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
apiKeyName:
{
Description: The name of the API Key resource. ,
Required: True ,
}
string ,
resource:
{
Description: The API key resource to create or update. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
secretText:
{
Description: The secret text for the API key ,
Format: password ,
Required: True ,
}
string ,
endDateTime:
{
Description: Expiry of the key in UTC date-time format. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hint:
{
Description: This is the name of the API key. ,
Required: True ,
}
string ,
endDateTime:
{
Description: Expiry of the key in UTC date-time format. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: API key resource returned by the service. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
hint:
{
Description: This is the name of the API key. ,
Required: True ,
}
string ,
endDateTime:
{
Description: Expiry of the key in UTC date-time format. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
ApiKeys_Delete (new)
Description :  Deletes the specified API key.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/apiKeys/{apiKeyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
apiKeyName:
{
Description: The name of the API Key resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Certificates_ListByDeployment (new)
Description :  Lists all certificates in a parent deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/certificates
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Certificate items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the certificate. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Description: The virtual path to the key file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/key.key. ,
Required: False ,
}
string ,
certificateVirtualPath:
{
Description: The virtual path to the certificate file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/cert.pem. ,
Required: False ,
}
string ,
keyVaultSecretId:
{
Description: The Key Vault secret ID. Example: `https://myvault.vault.azure.net/secrets/mysecret/1234567890abcdef1234567890abcdef`. ,
Format: uri ,
Required: False ,
}
string ,
sha1Thumbprint:
{
Description: The SHA1 thumbprint of the certificate. ,
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Description: The Key Vault secret version. ,
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Description: The creation time of the Key Vault secret in UTC RFC 3339 format. Example: `2025-07-08T10:11:08.856Z`. ,
Required: False ,
}
string ,
certificateError:
{
Description: Error details for the certificate, if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Certificates_Get (new)
Description :  Gets the properties of a specific certificate.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/certificates/{certificateName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
certificateName:
{
Description: The name of the Certificate ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the certificate. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Description: The virtual path to the key file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/key.key. ,
Required: False ,
}
string ,
certificateVirtualPath:
{
Description: The virtual path to the certificate file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/cert.pem. ,
Required: False ,
}
string ,
keyVaultSecretId:
{
Description: The Key Vault secret ID. Example: `https://myvault.vault.azure.net/secrets/mysecret/1234567890abcdef1234567890abcdef`. ,
Format: uri ,
Required: False ,
}
string ,
sha1Thumbprint:
{
Description: The SHA1 thumbprint of the certificate. ,
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Description: The Key Vault secret version. ,
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Description: The creation time of the Key Vault secret in UTC RFC 3339 format. Example: `2025-07-08T10:11:08.856Z`. ,
Required: False ,
}
string ,
certificateError:
{
Description: Error details for the certificate, if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
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 ,
}
,
]
,
}
,
}
Certificates_CreateOrUpdate (new)
Description :  Creates or updates a certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/certificates/{certificateName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
certificateName:
{
Description: The name of the Certificate ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the certificate. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Description: The virtual path to the key file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/key.key. ,
Required: False ,
}
string ,
certificateVirtualPath:
{
Description: The virtual path to the certificate file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/cert.pem. ,
Required: False ,
}
string ,
keyVaultSecretId:
{
Description: The Key Vault secret ID. Example: `https://myvault.vault.azure.net/secrets/mysecret/1234567890abcdef1234567890abcdef`. ,
Format: uri ,
Required: False ,
}
string ,
sha1Thumbprint:
{
Description: The SHA1 thumbprint of the certificate. ,
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Description: The Key Vault secret version. ,
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Description: The creation time of the Key Vault secret in UTC RFC 3339 format. Example: `2025-07-08T10:11:08.856Z`. ,
Required: False ,
}
string ,
certificateError:
{
Description: Error details for the certificate, if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the certificate. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Description: The virtual path to the key file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/key.key. ,
Required: False ,
}
string ,
certificateVirtualPath:
{
Description: The virtual path to the certificate file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/cert.pem. ,
Required: False ,
}
string ,
keyVaultSecretId:
{
Description: The Key Vault secret ID. Example: `https://myvault.vault.azure.net/secrets/mysecret/1234567890abcdef1234567890abcdef`. ,
Format: uri ,
Required: False ,
}
string ,
sha1Thumbprint:
{
Description: The SHA1 thumbprint of the certificate. ,
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Description: The Key Vault secret version. ,
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Description: The creation time of the Key Vault secret in UTC RFC 3339 format. Example: `2025-07-08T10:11:08.856Z`. ,
Required: False ,
}
string ,
certificateError:
{
Description: Error details for the certificate, if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: NginxCertificate resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the certificate. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Description: The virtual path to the key file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/key.key. ,
Required: False ,
}
string ,
certificateVirtualPath:
{
Description: The virtual path to the certificate file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/cert.pem. ,
Required: False ,
}
string ,
keyVaultSecretId:
{
Description: The Key Vault secret ID. Example: `https://myvault.vault.azure.net/secrets/mysecret/1234567890abcdef1234567890abcdef`. ,
Format: uri ,
Required: False ,
}
string ,
sha1Thumbprint:
{
Description: The SHA1 thumbprint of the certificate. ,
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Description: The Key Vault secret version. ,
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Description: The creation time of the Key Vault secret in UTC RFC 3339 format. Example: `2025-07-08T10:11:08.856Z`. ,
Required: False ,
}
string ,
certificateError:
{
Description: Error details for the certificate, if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
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 ,
}
,
]
,
}
,
}
Certificates_Update (new)
Description :  Updates a certificate with patch semantics.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/certificates/{certificateName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
certificateName:
{
Description: The name of the Certificate ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
keyVirtualPath:
{
Description: The virtual path to the key file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/key.key. ,
Required: False ,
}
string ,
certificateVirtualPath:
{
Description: The virtual path to the certificate file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/cert.pem. ,
Required: False ,
}
string ,
keyVaultSecretId:
{
Description: The Key Vault secret ID. Example: `https://myvault.vault.azure.net/secrets/mysecret/1234567890abcdef1234567890abcdef`. ,
Format: uri ,
Required: False ,
}
string ,
sha1Thumbprint:
{
Description: The SHA1 thumbprint of the certificate. ,
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Description: The Key Vault secret version. ,
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Description: The creation time of the Key Vault secret in UTC RFC 3339 format. Example: `2025-07-08T10:11:08.856Z`. ,
Required: False ,
}
string ,
certificateError:
{
Description: Error details for the certificate, if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the certificate. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Description: The virtual path to the key file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/key.key. ,
Required: False ,
}
string ,
certificateVirtualPath:
{
Description: The virtual path to the certificate file. This is a path that would be used in an Nginx configuration file, for example, /etc/nginx/ssl/cert.pem. ,
Required: False ,
}
string ,
keyVaultSecretId:
{
Description: The Key Vault secret ID. Example: `https://myvault.vault.azure.net/secrets/mysecret/1234567890abcdef1234567890abcdef`. ,
Format: uri ,
Required: False ,
}
string ,
sha1Thumbprint:
{
Description: The SHA1 thumbprint of the certificate. ,
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Description: The Key Vault secret version. ,
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Description: The creation time of the Key Vault secret in UTC RFC 3339 format. Example: `2025-07-08T10:11:08.856Z`. ,
Required: False ,
}
string ,
certificateError:
{
Description: Error details for the certificate, if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
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 ,
}
,
]
,
}
,
}
Certificates_Delete (new)
Description :  Deletes a specific certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/certificates/{certificateName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
certificateName:
{
Description: The name of the Certificate ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Configurations_ListByDeployment (new)
Description :  Lists all configurations in a parent deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/configurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Configuration items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
files:
{
Description: List of configuration files. ,
Required: False ,
}
[
{
content:
{
Description: File content in Nginx configuration format, base64 encoded. ,
Required: False ,
}
string ,
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Description: List of protected files. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
contentHash:
{
Description: Content hash of the file using SHA-256 algorithm. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Description: Configuration package details. ,
Required: False ,
}
{
data:
{
Description: Package data. This is base64 encoded content of the files archive. ,
Required: False ,
}
string ,
protectedFiles:
{
Description: List of protected files in the package. These are standard file paths relative to the archive uploaded ,
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Description: Root file of the configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Configurations_Get (new)
Description :  Retrieves the properties of a specific configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the Configuration ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
files:
{
Description: List of configuration files. ,
Required: False ,
}
[
{
content:
{
Description: File content in Nginx configuration format, base64 encoded. ,
Required: False ,
}
string ,
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Description: List of protected files. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
contentHash:
{
Description: Content hash of the file using SHA-256 algorithm. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Description: Configuration package details. ,
Required: False ,
}
{
data:
{
Description: Package data. This is base64 encoded content of the files archive. ,
Required: False ,
}
string ,
protectedFiles:
{
Description: List of protected files in the package. These are standard file paths relative to the archive uploaded ,
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Description: Root file of the configuration. ,
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 ,
}
,
]
,
}
,
}
Configurations_CreateOrUpdate (new)
Description :  Creates or updates a configuration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the Configuration ,
Required: True ,
}
string ,
resource:
{
Description: The configuration resource to create or update. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
files:
{
Description: List of configuration files. ,
Required: False ,
}
[
{
content:
{
Description: File content in Nginx configuration format, base64 encoded. ,
Required: False ,
}
string ,
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Description: List of protected file requests. ,
Required: False ,
}
[
{
content:
{
Description: File content in Nginx configuration format, UTF-8 encoded. ,
Required: False ,
}
string ,
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
contentHash:
{
Description: Content hash of the file using SHA-256 algorithm. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Description: Configuration package data. ,
Required: False ,
}
{
data:
{
Description: Package data. This is base64 encoded content of the files archive. ,
Required: False ,
}
string ,
protectedFiles:
{
Description: List of protected files in the package. These are standard file paths relative to the archive uploaded ,
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Description: Root file path. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
files:
{
Description: List of configuration files. ,
Required: False ,
}
[
{
content:
{
Description: File content in Nginx configuration format, base64 encoded. ,
Required: False ,
}
string ,
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Description: List of protected files. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
contentHash:
{
Description: Content hash of the file using SHA-256 algorithm. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Description: Configuration package details. ,
Required: False ,
}
{
data:
{
Description: Package data. This is base64 encoded content of the files archive. ,
Required: False ,
}
string ,
protectedFiles:
{
Description: List of protected files in the package. These are standard file paths relative to the archive uploaded ,
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Description: Root file of the configuration. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Represents an Nginx configuration resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
files:
{
Description: List of configuration files. ,
Required: False ,
}
[
{
content:
{
Description: File content in Nginx configuration format, base64 encoded. ,
Required: False ,
}
string ,
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Description: List of protected files. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
contentHash:
{
Description: Content hash of the file using SHA-256 algorithm. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Description: Configuration package details. ,
Required: False ,
}
{
data:
{
Description: Package data. This is base64 encoded content of the files archive. ,
Required: False ,
}
string ,
protectedFiles:
{
Description: List of protected files in the package. These are standard file paths relative to the archive uploaded ,
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Description: Root file of the configuration. ,
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 ,
}
,
]
,
}
,
}
Configurations_Update (new)
Description :  Patches an existing configuration.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the Configuration ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
files:
{
Description: List of configuration files. ,
Required: False ,
}
[
{
content:
{
Description: File content in Nginx configuration format, base64 encoded. ,
Required: False ,
}
string ,
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Description: List of protected file requests. ,
Required: False ,
}
[
{
content:
{
Description: File content in Nginx configuration format, UTF-8 encoded. ,
Required: False ,
}
string ,
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
contentHash:
{
Description: Content hash of the file using SHA-256 algorithm. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Description: Configuration package data. ,
Required: False ,
}
{
data:
{
Description: Package data. This is base64 encoded content of the files archive. ,
Required: False ,
}
string ,
protectedFiles:
{
Description: List of protected files in the package. These are standard file paths relative to the archive uploaded ,
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Description: Root file path. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
files:
{
Description: List of configuration files. ,
Required: False ,
}
[
{
content:
{
Description: File content in Nginx configuration format, base64 encoded. ,
Required: False ,
}
string ,
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Description: List of protected files. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
contentHash:
{
Description: Content hash of the file using SHA-256 algorithm. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Description: Configuration package details. ,
Required: False ,
}
{
data:
{
Description: Package data. This is base64 encoded content of the files archive. ,
Required: False ,
}
string ,
protectedFiles:
{
Description: List of protected files in the package. These are standard file paths relative to the archive uploaded ,
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Description: Root file of the configuration. ,
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 ,
}
,
]
,
}
,
}
Configurations_Delete (new)
Description :  Deletes a specific configuration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the Configuration ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Configurations_Analyze (new)
Description :  Analyzes a configuration for potential issues or optimizations.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/configurations/{configurationName}/analyze
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the Configuration ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
config:
{
Description: Configuration details for analysis. ,
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:
{
Description: List of configuration files. ,
Required: False ,
}
[
{
content:
{
Description: File content in Nginx configuration format, base64 encoded. ,
Required: False ,
}
string ,
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Description: List of protected files. ,
Required: False ,
}
[
{
content:
{
Description: File content in Nginx configuration format, UTF-8 encoded. ,
Required: False ,
}
string ,
virtualPath:
{
Description: Virtual path of the file. ,
Required: False ,
}
string ,
contentHash:
{
Description: Content hash of the file using SHA-256 algorithm. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Description: Configuration package details. ,
Required: False ,
}
{
data:
{
Description: Package data. This is base64 encoded content of the files archive. ,
Required: False ,
}
string ,
protectedFiles:
{
Description: List of protected files in the package. These are standard file paths relative to the archive uploaded ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
status:
{
Description: The status of the analysis. ,
Required: True ,
}
string ,
data:
{
Description: Analysis result data. ,
Required: False ,
}
{
errors:
{
Description: List of errors found during analysis. ,
Required: False ,
}
[
{
id:
{
Description: Unique identifier for the error. ,
Required: False ,
}
string ,
directive:
{
Description: The directive being analyzed. ,
Required: True ,
}
string ,
description:
{
Description: Description of the error. ,
Required: True ,
}
string ,
file:
{
Description: The filepath of the most relevant config file. ,
Required: True ,
}
string ,
line:
{
Description: Line number where the error was found. ,
Format: int64 ,
Required: True ,
}
integer ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
rule:
{
Description: Rule that triggered the error. ,
Required: True ,
}
string ,
}
,
]
,
diagnostics:
{
Description: List of diagnostics found during analysis. ,
Required: False ,
}
[
{
id:
{
Description: Unique identifier for the diagnostic error type. Generated by the analyzer as a free form text. ,
Required: False ,
}
string ,
directive:
{
Description: The directive being analyzed. This is a free form text that can be used to identify the directive. ,
Required: True ,
}
string ,
description:
{
Description: Description of the diagnostic. ,
Required: True ,
}
string ,
file:
{
Description: The filepath of the most relevant config file. ,
Required: True ,
}
string ,
line:
{
Description: Line number where the diagnostic was found. ,
Format: int64 ,
Required: True ,
}
integer ,
message:
{
Description: Diagnostic message. ,
Required: True ,
}
string ,
rule:
{
Description: Rule that triggered the diagnostic. Rule names can be any free form text that can be used to identify. ,
Required: True ,
}
string ,
level:
{
Description: Warning or Info. ,
Enum:
{
Info: Information level diagnostic. ,
Warning: Warning level diagnostic. ,
}
,
Required: True ,
}
enum ,
category:
{
Description: Category of warning like Best-practices, Recommendation, Security etc. Can be any free form text. ,
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 ,
}
,
]
,
}
,
}
NginxDeployments_ListDefaultWafPolicies (new)
Description :  Lists the default WAF policies for a deployment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/listDefaultWafPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of default WAF policies. ,
Required: True ,
}
[
{
content:
{
Description: The raw policy content, base64-encoded. ,
Format: byte ,
Required: True ,
}
string ,
filepath:
{
Description: The file path where this policy would be placed. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to fetch the next page of WAF policies. ,
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 ,
}
,
]
,
}
,
}
WafPolicies_ListByDeployment (new)
Description :  List all WAF policies in a deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/wafPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NginxDeploymentWafPolicyMetadata items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
filepath:
{
Description: The file path of the WAF policy metadata. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the WAF policy metadata. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
compilingState:
{
Description: The compiling status of the WAF policy metadata. ,
Required: True ,
}
{
code:
{
Description: The compilation status code. Can be any free form text ,
Required: True ,
}
string ,
displayStatus:
{
Description: The human-readable compilation status. ,
Required: True ,
}
string ,
time:
{
Description: The timestamp when compilation status was recorded in UTC timezone and RFC 3339 format. Example: `2025-07-08T10:11:08.856Z`. ,
Required: True ,
}
string ,
}
,
applyingState:
{
Description: The applying status of the WAF policy metadata. ,
Required: True ,
}
{
code:
{
Description: The apply status code. Can be any free form text ,
Required: True ,
}
string ,
displayStatus:
{
Description: The human-readable apply status. ,
Required: True ,
}
string ,
time:
{
Description: The timestamp when apply status was recorded in UTC. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
WafPolicies_Get (new)
Description :  Read a specific WAF policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/wafPolicies/{wafPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
wafPolicyName:
{
Description: The name of the WafPolicy ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
content:
{
Description: The raw policy content (base64-encoded). ,
Format: byte ,
Required: True ,
}
string ,
filepath:
{
Description: The file path of the WAF policy. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the WAF policy. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
compilingState:
{
Description: The compiling status of the WAF policy. ,
Required: True ,
}
{
code:
{
Description: The compilation status code. Can be any free form text ,
Required: True ,
}
string ,
displayStatus:
{
Description: The human-readable compilation status. ,
Required: True ,
}
string ,
time:
{
Description: The timestamp when compilation status was recorded in UTC timezone and RFC 3339 format. Example: `2025-07-08T10:11:08.856Z`. ,
Required: True ,
}
string ,
}
,
applyingState:
{
Description: The applying status of the WAF policy. ,
Required: True ,
}
{
code:
{
Description: The apply status code. Can be any free form text ,
Required: True ,
}
string ,
displayStatus:
{
Description: The human-readable apply status. ,
Required: True ,
}
string ,
time:
{
Description: The timestamp when apply status was recorded in UTC. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
WafPolicies_CreateOrUpdate (new)
Description :  Create or update a WAF policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/wafPolicies/{wafPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
wafPolicyName:
{
Description: The name of the WafPolicy ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
content:
{
Description: The raw policy content (base64-encoded). ,
Format: byte ,
Required: True ,
}
string ,
filepath:
{
Description: The file path of the WAF policy. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the WAF policy. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
compilingState:
{
Description: The compiling status of the WAF policy. ,
Required: True ,
}
{
code:
{
Description: The compilation status code. Can be any free form text ,
Required: True ,
}
string ,
displayStatus:
{
Description: The human-readable compilation status. ,
Required: True ,
}
string ,
time:
{
Description: The timestamp when compilation status was recorded in UTC timezone and RFC 3339 format. Example: `2025-07-08T10:11:08.856Z`. ,
Required: True ,
}
string ,
}
,
applyingState:
{
Description: The applying status of the WAF policy. ,
Required: True ,
}
{
code:
{
Description: The apply status code. Can be any free form text ,
Required: True ,
}
string ,
displayStatus:
{
Description: The human-readable apply status. ,
Required: True ,
}
string ,
time:
{
Description: The timestamp when apply status was recorded in UTC. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
content:
{
Description: The raw policy content (base64-encoded). ,
Format: byte ,
Required: True ,
}
string ,
filepath:
{
Description: The file path of the WAF policy. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the WAF policy. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
compilingState:
{
Description: The compiling status of the WAF policy. ,
Required: True ,
}
{
code:
{
Description: The compilation status code. Can be any free form text ,
Required: True ,
}
string ,
displayStatus:
{
Description: The human-readable compilation status. ,
Required: True ,
}
string ,
time:
{
Description: The timestamp when compilation status was recorded in UTC timezone and RFC 3339 format. Example: `2025-07-08T10:11:08.856Z`. ,
Required: True ,
}
string ,
}
,
applyingState:
{
Description: The applying status of the WAF policy. ,
Required: True ,
}
{
code:
{
Description: The apply status code. Can be any free form text ,
Required: True ,
}
string ,
displayStatus:
{
Description: The human-readable apply status. ,
Required: True ,
}
string ,
time:
{
Description: The timestamp when apply status was recorded in UTC. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Represents a WAF policy resource under a given Nginx deployment. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
content:
{
Description: The raw policy content (base64-encoded). ,
Format: byte ,
Required: True ,
}
string ,
filepath:
{
Description: The file path of the WAF policy. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the WAF policy. ,
Enum:
{
Accepted: The resource has been accepted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Succeeded: The resource has been successfully provisioned. ,
Failed: The resource provisioning operation failed. ,
Canceled: The resource provisioning was canceled. ,
Deleted: The resource has been deleted. ,
NotSpecified: Provisioning state was not specified. ,
}
,
Required: False ,
}
enum ,
compilingState:
{
Description: The compiling status of the WAF policy. ,
Required: True ,
}
{
code:
{
Description: The compilation status code. Can be any free form text ,
Required: True ,
}
string ,
displayStatus:
{
Description: The human-readable compilation status. ,
Required: True ,
}
string ,
time:
{
Description: The timestamp when compilation status was recorded in UTC timezone and RFC 3339 format. Example: `2025-07-08T10:11:08.856Z`. ,
Required: True ,
}
string ,
}
,
applyingState:
{
Description: The applying status of the WAF policy. ,
Required: True ,
}
{
code:
{
Description: The apply status code. Can be any free form text ,
Required: True ,
}
string ,
displayStatus:
{
Description: The human-readable apply status. ,
Required: True ,
}
string ,
time:
{
Description: The timestamp when apply status was recorded in UTC. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
WafPolicies_Delete (new)
Description :  Delete a specific WAF policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NGINX.NGINXPLUS/nginxDeployments/{nginxDeploymentName}/wafPolicies/{wafPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
nginxDeploymentName:
{
Description: The name of the Nginx deployment resource. ,
Required: True ,
}
string ,
wafPolicyName:
{
Description: The name of the WafPolicy ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}