Nginx.NginxPlus (preview:2024-09-01)

2025/08/06 • 20 new, 20 deleted methods

ApiKeys_CreateOrUpdate (new)
Description :  Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/apiKeys/{apiKeyName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
apiKeyName:
{
Description: The resource name of the API key ,
Required: True ,
}
string ,
body:
{
Description: The API Key object containing fields (e.g. secret text, expiration date) to upsert the key. ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
secretText:
{
Description: Secret text to be used as a Dataplane API Key. This is a write only property that can never be read back, but the first three characters will be returned in the 'hint' property. ,
Format: password ,
Required: False ,
}
string ,
endDateTime:
{
Description: The time after which this Dataplane API Key is no longer valid. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
hint:
{
Description: The first three characters of the secret text to help identify it in use. This property is read-only. ,
Required: False ,
}
string ,
endDateTime:
{
Description: The time after which this Dataplane API Key is no longer valid. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
hint:
{
Description: The first three characters of the secret text to help identify it in use. This property is read-only. ,
Required: False ,
}
string ,
endDateTime:
{
Description: The time after which this Dataplane API Key is no longer valid. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Delete API key for Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Get the specified API Key of the given Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
hint:
{
Description: The first three characters of the secret text to help identify it in use. This property is read-only. ,
Required: False ,
}
string ,
endDateTime:
{
Description: The time after which this Dataplane API Key is no longer valid. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_List (new)
Description :  List all API Keys of the given Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
hint:
{
Description: The first three characters of the secret text to help identify it in use. This property is read-only. ,
Required: False ,
}
string ,
endDateTime:
{
Description: The time after which this Dataplane API Key is no longer valid. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Get a certificate of given Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Required: False ,
}
string ,
certificateVirtualPath:
{
Required: False ,
}
string ,
keyVaultSecretId:
{
Required: False ,
}
string ,
sha1Thumbprint:
{
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Format: date-time ,
Required: False ,
}
string ,
certificateError:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Create or update the Nginx certificates for given Nginx deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/certificates/{certificateName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
certificateName:
{
Description: The name of certificate ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The certificate ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Required: False ,
}
string ,
certificateVirtualPath:
{
Required: False ,
}
string ,
keyVaultSecretId:
{
Required: False ,
}
string ,
sha1Thumbprint:
{
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Format: date-time ,
Required: False ,
}
string ,
certificateError:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Required: False ,
}
string ,
certificateVirtualPath:
{
Required: False ,
}
string ,
keyVaultSecretId:
{
Required: False ,
}
string ,
sha1Thumbprint:
{
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Format: date-time ,
Required: False ,
}
string ,
certificateError:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Required: False ,
}
string ,
certificateVirtualPath:
{
Required: False ,
}
string ,
keyVaultSecretId:
{
Required: False ,
}
string ,
sha1Thumbprint:
{
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Format: date-time ,
Required: False ,
}
string ,
certificateError:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 certificate from the Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_List (new)
Description :  List all certificates of given Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Required: False ,
}
string ,
certificateVirtualPath:
{
Required: False ,
}
string ,
keyVaultSecretId:
{
Required: False ,
}
string ,
sha1Thumbprint:
{
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Format: date-time ,
Required: False ,
}
string ,
certificateError:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_List (new)
Description :  List the Nginx configuration of given Nginx deployment.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
files:
{
Required: False ,
}
[
{
content:
{
Required: False ,
}
string ,
virtualPath:
{
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Required: False ,
}
[
{
virtualPath:
{
Description: The virtual path of the protected file. ,
Required: False ,
}
string ,
contentHash:
{
Description: The hash of the content of the file. This value is used to determine if the file has changed. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Required: False ,
}
{
data:
{
Required: False ,
}
string ,
protectedFiles:
{
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Get the Nginx configuration of given Nginx deployment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
files:
{
Required: False ,
}
[
{
content:
{
Required: False ,
}
string ,
virtualPath:
{
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Required: False ,
}
[
{
virtualPath:
{
Description: The virtual path of the protected file. ,
Required: False ,
}
string ,
contentHash:
{
Description: The hash of the content of the file. This value is used to determine if the file has changed. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Required: False ,
}
{
data:
{
Required: False ,
}
string ,
protectedFiles:
{
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Create or update the Nginx configuration for given Nginx deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The Nginx configuration ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
files:
{
Required: False ,
}
[
{
content:
{
Required: False ,
}
string ,
virtualPath:
{
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Required: False ,
}
[
{
content:
{
Description: The content of the protected file. This value is a PUT only value. If you perform a GET request on this value, it will be empty because it is a protected file. ,
Required: False ,
}
string ,
virtualPath:
{
Description: The virtual path of the protected file. ,
Required: False ,
}
string ,
contentHash:
{
Description: The hash of the content of the file. This value is used to determine if the file has changed. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Required: False ,
}
{
data:
{
Required: False ,
}
string ,
protectedFiles:
{
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
files:
{
Required: False ,
}
[
{
content:
{
Required: False ,
}
string ,
virtualPath:
{
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Required: False ,
}
[
{
virtualPath:
{
Description: The virtual path of the protected file. ,
Required: False ,
}
string ,
contentHash:
{
Description: The hash of the content of the file. This value is used to determine if the file has changed. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Required: False ,
}
{
data:
{
Required: False ,
}
string ,
protectedFiles:
{
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
files:
{
Required: False ,
}
[
{
content:
{
Required: False ,
}
string ,
virtualPath:
{
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Required: False ,
}
[
{
virtualPath:
{
Description: The virtual path of the protected file. ,
Required: False ,
}
string ,
contentHash:
{
Description: The hash of the content of the file. This value is used to determine if the file has changed. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Required: False ,
}
{
data:
{
Required: False ,
}
string ,
protectedFiles:
{
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Reset the Nginx configuration of given Nginx deployment to default
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_Analysis (new)
Description :  Analyze an Nginx configuration without applying it to the NginxaaS deployment
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}/analyze
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The Nginx configuration to analyze ,
Required: False ,
}
{
config:
{
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:
{
Required: False ,
}
[
{
content:
{
Required: False ,
}
string ,
virtualPath:
{
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Required: False ,
}
[
{
content:
{
Description: The content of the protected file. This value is a PUT only value. If you perform a GET request on this value, it will be empty because it is a protected file. ,
Required: False ,
}
string ,
virtualPath:
{
Description: The virtual path of the protected file. ,
Required: False ,
}
string ,
contentHash:
{
Description: The hash of the content of the file. This value is used to determine if the file has changed. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Required: False ,
}
{
data:
{
Required: False ,
}
string ,
protectedFiles:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
status:
{
Description: The status of the analysis. ,
Required: True ,
}
string ,
data:
{
Required: False ,
}
{
errors:
{
Required: False ,
}
[
{
id:
{
Description: Unique identifier for the error ,
Required: False ,
}
string ,
directive:
{
Required: True ,
}
string ,
description:
{
Required: True ,
}
string ,
file:
{
Description: the filepath of the most relevant config file ,
Required: True ,
}
string ,
line:
{
Required: True ,
}
number ,
message:
{
Required: True ,
}
string ,
rule:
{
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Deployments_Get (new)
Description :  Get the Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdate (new)
Description :  Create or update the Nginx deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Deployments_Update (new)
Description :  Update the Nginx deployment
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
nginxAppProtect:
{
Description: Update settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: False ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Deployments_Delete (new)
Description :  Delete the Nginx deployment resource
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Deployments_List (new)
Description :  List the Nginx deployments resources
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Deployments_ListByResourceGroup (new)
Description :  List all Nginx deployments under the specified resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List all operations provided by Nginx.NginxPlus for the 2024-06-01-preview api version.
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 Nginx.NginxPlus provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Nginx.NginxPlus ,
Required: False ,
}
string ,
resource:
{
Description: Type on which the operation is performed, e.g., 'deployments'. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type, e.g., read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation, e.g., 'Write deployments'. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/apiKeys/{apiKeyName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
apiKeyName:
{
Description: The resource name of the API key ,
Required: True ,
}
string ,
body:
{
Description: The API Key object containing fields (e.g. secret text, expiration date) to upsert the key. ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
secretText:
{
Description: Secret text to be used as a Dataplane API Key. This is a write only property that can never be read back, but the first three characters will be returned in the 'hint' property. ,
Format: password ,
Required: False ,
}
string ,
endDateTime:
{
Description: The time after which this Dataplane API Key is no longer valid. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
hint:
{
Description: The first three characters of the secret text to help identify it in use. This property is read-only. ,
Required: False ,
}
string ,
endDateTime:
{
Description: The time after which this Dataplane API Key is no longer valid. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
hint:
{
Description: The first three characters of the secret text to help identify it in use. This property is read-only. ,
Required: False ,
}
string ,
endDateTime:
{
Description: The time after which this Dataplane API Key is no longer valid. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete API key for Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get the specified API Key of the given Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
hint:
{
Description: The first three characters of the secret text to help identify it in use. This property is read-only. ,
Required: False ,
}
string ,
endDateTime:
{
Description: The time after which this Dataplane API Key is no longer valid. ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_List (removed)
Description :  List all API Keys of the given Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
hint:
{
Description: The first three characters of the secret text to help identify it in use. This property is read-only. ,
Required: False ,
}
string ,
endDateTime:
{
Description: The time after which this Dataplane API Key is no longer valid. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get a certificate of given Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Required: False ,
}
string ,
certificateVirtualPath:
{
Required: False ,
}
string ,
keyVaultSecretId:
{
Required: False ,
}
string ,
sha1Thumbprint:
{
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Format: date-time ,
Required: False ,
}
string ,
certificateError:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update the Nginx certificates for given Nginx deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/certificates/{certificateName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
certificateName:
{
Description: The name of certificate ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The certificate ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Required: False ,
}
string ,
certificateVirtualPath:
{
Required: False ,
}
string ,
keyVaultSecretId:
{
Required: False ,
}
string ,
sha1Thumbprint:
{
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Format: date-time ,
Required: False ,
}
string ,
certificateError:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Required: False ,
}
string ,
certificateVirtualPath:
{
Required: False ,
}
string ,
keyVaultSecretId:
{
Required: False ,
}
string ,
sha1Thumbprint:
{
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Format: date-time ,
Required: False ,
}
string ,
certificateError:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Required: False ,
}
string ,
certificateVirtualPath:
{
Required: False ,
}
string ,
keyVaultSecretId:
{
Required: False ,
}
string ,
sha1Thumbprint:
{
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Format: date-time ,
Required: False ,
}
string ,
certificateError:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Deletes a certificate from the Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_List (removed)
Description :  List all certificates of given Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
keyVirtualPath:
{
Required: False ,
}
string ,
certificateVirtualPath:
{
Required: False ,
}
string ,
keyVaultSecretId:
{
Required: False ,
}
string ,
sha1Thumbprint:
{
Required: False ,
}
string ,
keyVaultSecretVersion:
{
Required: False ,
}
string ,
keyVaultSecretCreated:
{
Format: date-time ,
Required: False ,
}
string ,
certificateError:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_List (removed)
Description :  List the Nginx configuration of given Nginx deployment.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
files:
{
Required: False ,
}
[
{
content:
{
Required: False ,
}
string ,
virtualPath:
{
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Required: False ,
}
[
{
virtualPath:
{
Description: The virtual path of the protected file. ,
Required: False ,
}
string ,
contentHash:
{
Description: The hash of the content of the file. This value is used to determine if the file has changed. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Required: False ,
}
{
data:
{
Required: False ,
}
string ,
protectedFiles:
{
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get the Nginx configuration of given Nginx deployment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
files:
{
Required: False ,
}
[
{
content:
{
Required: False ,
}
string ,
virtualPath:
{
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Required: False ,
}
[
{
virtualPath:
{
Description: The virtual path of the protected file. ,
Required: False ,
}
string ,
contentHash:
{
Description: The hash of the content of the file. This value is used to determine if the file has changed. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Required: False ,
}
{
data:
{
Required: False ,
}
string ,
protectedFiles:
{
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update the Nginx configuration for given Nginx deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The Nginx configuration ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
files:
{
Required: False ,
}
[
{
content:
{
Required: False ,
}
string ,
virtualPath:
{
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Required: False ,
}
[
{
content:
{
Description: The content of the protected file. This value is a PUT only value. If you perform a GET request on this value, it will be empty because it is a protected file. ,
Required: False ,
}
string ,
virtualPath:
{
Description: The virtual path of the protected file. ,
Required: False ,
}
string ,
contentHash:
{
Description: The hash of the content of the file. This value is used to determine if the file has changed. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Required: False ,
}
{
data:
{
Required: False ,
}
string ,
protectedFiles:
{
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
files:
{
Required: False ,
}
[
{
content:
{
Required: False ,
}
string ,
virtualPath:
{
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Required: False ,
}
[
{
virtualPath:
{
Description: The virtual path of the protected file. ,
Required: False ,
}
string ,
contentHash:
{
Description: The hash of the content of the file. This value is used to determine if the file has changed. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Required: False ,
}
{
data:
{
Required: False ,
}
string ,
protectedFiles:
{
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
files:
{
Required: False ,
}
[
{
content:
{
Required: False ,
}
string ,
virtualPath:
{
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Required: False ,
}
[
{
virtualPath:
{
Description: The virtual path of the protected file. ,
Required: False ,
}
string ,
contentHash:
{
Description: The hash of the content of the file. This value is used to determine if the file has changed. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Required: False ,
}
{
data:
{
Required: False ,
}
string ,
protectedFiles:
{
Required: False ,
}
[
string ,
]
,
}
,
rootFile:
{
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Reset the Nginx configuration of given Nginx deployment to default
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_Analysis (removed)
Description :  Analyze an Nginx configuration without applying it to the NginxaaS deployment
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}/analyze
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of configuration, only 'default' is supported value due to the singleton of Nginx conf ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The Nginx configuration to analyze ,
Required: False ,
}
{
config:
{
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:
{
Required: False ,
}
[
{
content:
{
Required: False ,
}
string ,
virtualPath:
{
Required: False ,
}
string ,
}
,
]
,
protectedFiles:
{
Required: False ,
}
[
{
content:
{
Description: The content of the protected file. This value is a PUT only value. If you perform a GET request on this value, it will be empty because it is a protected file. ,
Required: False ,
}
string ,
virtualPath:
{
Description: The virtual path of the protected file. ,
Required: False ,
}
string ,
contentHash:
{
Description: The hash of the content of the file. This value is used to determine if the file has changed. ,
Required: False ,
}
string ,
}
,
]
,
package:
{
Required: False ,
}
{
data:
{
Required: False ,
}
string ,
protectedFiles:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
status:
{
Description: The status of the analysis. ,
Required: True ,
}
string ,
data:
{
Required: False ,
}
{
errors:
{
Required: False ,
}
[
{
id:
{
Description: Unique identifier for the error ,
Required: False ,
}
string ,
directive:
{
Required: True ,
}
string ,
description:
{
Required: True ,
}
string ,
file:
{
Description: the filepath of the most relevant config file ,
Required: True ,
}
string ,
line:
{
Required: True ,
}
number ,
message:
{
Required: True ,
}
string ,
rule:
{
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Deployments_Get (removed)
Description :  Get the Nginx deployment
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdate (removed)
Description :  Create or update the Nginx deployment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Deployments_Update (removed)
Description :  Update the Nginx deployment
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}
{
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 ,
deploymentName:
{
Description: The name of targeted Nginx deployment ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
nginxAppProtect:
{
Description: Update settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: False ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Deployments_Delete (removed)
Description :  Delete the Nginx deployment resource
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Deployments_List (removed)
Description :  List the Nginx deployments resources
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Deployments_ListByResourceGroup (removed)
Description :  List all Nginx deployments under the specified resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
principalId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
type:
{
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Required: False ,
}
object ,
}
,
properties:
{
Required: False ,
}
{
provisioningState:
{
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
nginxVersion:
{
Required: False ,
}
string ,
networkProfile:
{
Required: False ,
}
{
frontEndIPConfiguration:
{
Required: False ,
}
{
publicIPAddresses:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
privateIPAddresses:
{
Required: False ,
}
[
{
privateIPAddress:
{
Required: False ,
}
string ,
privateIPAllocationMethod:
{
Enum:
{
Static: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
subnetId:
{
Required: False ,
}
string ,
}
,
]
,
}
,
networkInterfaceConfiguration:
{
Required: False ,
}
{
subnetId:
{
Required: False ,
}
string ,
}
,
}
,
ipAddress:
{
Description: The IP address of the deployment. ,
Required: False ,
}
string ,
enableDiagnosticsSupport:
{
Required: False ,
}
boolean ,
logging:
{
Required: False ,
}
{
storageAccount:
{
Required: False ,
}
{
accountName:
{
Required: False ,
}
string ,
containerName:
{
Required: False ,
}
string ,
}
,
}
,
scalingProperties:
{
Description: Information on how the deployment will be scaled. ,
Required: False ,
}
{
capacity:
{
Format: int32 ,
Required: False ,
}
integer ,
autoScaleSettings:
{
Description: The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. ,
Required: False ,
}
{
profiles:
{
Required: True ,
}
[
{
name:
{
Required: True ,
}
string ,
capacity:
{
Description: The capacity parameters of the profile. ,
Required: True ,
}
{
min:
{
Description: The minimum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum number of NCUs the deployment can be autoscaled to. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
autoUpgradeProfile:
{
Description: Autoupgrade settings of a deployment. ,
Required: False ,
}
{
upgradeChannel:
{
Description: Channel used for autoupgrade. ,
Required: True ,
}
string ,
}
,
userProfile:
{
Required: False ,
}
{
preferredEmail:
{
Description: The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address. ,
Format: email ,
Required: False ,
}
string ,
}
,
nginxAppProtect:
{
Description: Settings for Nginx App Protect (NAP) ,
Required: False ,
}
{
webApplicationFirewallSettings:
{
Description: Settings for the Nginx App Protect Web Application Firewall (WAF) ,
Required: True ,
}
{
activationState:
{
Description: The activation state of the WAF. Use 'Enabled' to enable the WAF and 'Disabled' to disable it. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
webApplicationFirewallStatus:
{
Description: The status of the Nginx App Protect Web Application Firewall ,
Required: False ,
}
{
attackSignaturesPackage:
{
Description: Package containing attack signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
botSignaturesPackage:
{
Description: Package containing bot signatures for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
threatCampaignsPackage:
{
Description: Package containing threat campaigns for the Nginx App Protect Web Application Firewall (WAF). ,
Required: False ,
}
{
version:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) package. ,
Required: True ,
}
string ,
revisionDatetime:
{
Description: The date and time of the package revision. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
componentVersions:
{
Description: Versions of the Nginx App Protect Web Application Firewall (WAF) components. ,
Required: False ,
}
{
wafEngineVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) engine. ,
Required: True ,
}
string ,
wafNginxVersion:
{
Description: The version of the Nginx App Protect Web Application Firewall (WAF) module for Nginx. ,
Required: True ,
}
string ,
}
,
}
,
}
,
dataplaneApiEndpoint:
{
Description: Dataplane API endpoint for the caller to update the Nginx state of the deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Required: False ,
}
object ,
sku:
{
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
location:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  List all operations provided by Nginx.NginxPlus for the 2024-06-01-preview api version.
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 Nginx.NginxPlus provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Nginx.NginxPlus ,
Required: False ,
}
string ,
resource:
{
Description: Type on which the operation is performed, e.g., 'deployments'. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type, e.g., read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation, e.g., 'Write deployments'. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}