{ "swagger": "2.0", "info": { "title": "Nginx.NginxPlus", "version": "2021-05-01-preview" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/certificates/{certificateName}": { "get": { "tags": [ "NginxCertificate" ], "summary": "Get a certificate of given Nginx deployment", "operationId": "Certificates_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DeploymentNameParameter" }, { "in": "path", "name": "certificateName", "description": "The name of certificate", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/NginxCertificate" } }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-examples": { "Certificates_Get": { "$ref": "./examples/Certificates_Get.json" } } }, "put": { "tags": [ "NginxCertificate" ], "summary": "Create or update the Nginx certificates for given Nginx deployment", "operationId": "Certificates_Create", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DeploymentNameParameter" }, { "in": "path", "name": "certificateName", "description": "The name of certificate", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "The certificate", "schema": { "$ref": "#/definitions/NginxCertificate" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/NginxCertificate" } }, "201": { "description": "Success", "schema": { "$ref": "#/definitions/NginxCertificate" } }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Certificates_CreateOrUpdate": { "$ref": "./examples/Certificates_CreateOrUpdate.json" } } }, "delete": { "tags": [ "NginxCertificate" ], "summary": "Deletes a certificate from the nginx deployment", "operationId": "Certificates_Delete", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DeploymentNameParameter" }, { "in": "path", "name": "certificateName", "description": "The name of certificate", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success" }, "202": { "description": "Success" }, "204": { "description": "Success" }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Certificates_Delete": { "$ref": "./examples/Certificates_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/certificates": { "get": { "tags": [ "NginxCertificate" ], "summary": "List all certificates of given Nginx deployment", "operationId": "Certificates_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DeploymentNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/NginxCertificateListResponse" } }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "Certificates_List": { "$ref": "./examples/Certificates_List.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations": { "get": { "tags": [ "NginxConfiguration" ], "summary": "List the Nginx configuration of given Nginx deployment.", "operationId": "Configurations_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DeploymentNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/NginxConfigurationListResponse" } }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "Configurations_List": { "$ref": "./examples/Configurations_List.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}": { "get": { "tags": [ "NginxConfiguration" ], "summary": "Get the Nginx configuration of given Nginx deployment", "operationId": "Configurations_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DeploymentNameParameter" }, { "in": "path", "name": "configurationName", "description": "The name of configuration, only 'default' is supported value due to the singleton of Nginx conf", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/NginxConfiguration" } }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-examples": { "Configurations_Get": { "$ref": "./examples/Configurations_Get.json" } } }, "put": { "tags": [ "NginxConfiguration" ], "summary": "Create or update the Nginx configuration for given Nginx deployment", "operationId": "Configurations_CreateOrUpdate", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DeploymentNameParameter" }, { "in": "path", "name": "configurationName", "description": "The name of configuration, only 'default' is supported value due to the singleton of Nginx conf", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "The Nginx configuration", "schema": { "$ref": "#/definitions/NginxConfiguration" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/NginxConfiguration" } }, "201": { "description": "Success", "schema": { "$ref": "#/definitions/NginxConfiguration" } }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Configurations_CreateOrUpdate": { "$ref": "./examples/Configurations_CreateOrUpdate.json" } } }, "delete": { "tags": [ "NginxConfiguration" ], "summary": "Reset the Nginx configuration of given Nginx deployment to default", "operationId": "Configurations_Delete", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DeploymentNameParameter" }, { "in": "path", "name": "configurationName", "description": "The name of configuration, only 'default' is supported value due to the singleton of Nginx conf", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success" }, "202": { "description": "Success" }, "204": { "description": "Success" }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Configurations_Delete": { "$ref": "./examples/Configurations_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}": { "get": { "tags": [ "NginxDeployment" ], "summary": "Get the Nginx deployment", "operationId": "Deployments_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DeploymentNameParameter" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/NginxDeployment" } }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-examples": { "Deployments_Get": { "$ref": "./examples/Deployments_Get.json" } } }, "put": { "tags": [ "NginxDeployment" ], "summary": "Create or update the Nginx deployment", "operationId": "Deployments_Create", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DeploymentNameParameter" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/NginxDeployment" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/NginxDeployment" } }, "201": { "description": "Success", "schema": { "$ref": "#/definitions/NginxDeployment" } }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Deployments_Create": { "$ref": "./examples/Deployments_Create.json" } } }, "patch": { "tags": [ "NginxDeployment" ], "summary": "Update the Nginx deployment", "operationId": "Deployments_Update", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DeploymentNameParameter" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/NginxDeploymentUpdateParameters" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/NginxDeployment" } }, "201": { "description": "Success", "schema": { "$ref": "#/definitions/NginxDeployment" } }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-examples": { "Deployments_Update": { "$ref": "./examples/Deployments_Update.json" } }, "x-ms-long-running-operation": true }, "delete": { "tags": [ "NginxDeployment" ], "summary": "Delete the Nginx deployment resource", "operationId": "Deployments_Delete", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DeploymentNameParameter" } ], "responses": { "200": { "description": "Success" }, "202": { "description": "Success" }, "204": { "description": "Success" }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Deployments_Delete": { "$ref": "./examples/Deployments_Delete.json" } } } }, "/subscriptions/{subscriptionId}/providers/Nginx.NginxPlus/nginxDeployments": { "get": { "tags": [ "NginxDeployment" ], "summary": "List the Nginx deployments resources", "operationId": "Deployments_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/NginxDeploymentListResponse" } }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "Deployments_List": { "$ref": "./examples/Deployments_List.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments": { "get": { "tags": [ "NginxDeployment" ], "summary": "List all Nginx deployments under the specified resource group.", "operationId": "Deployments_ListByResourceGroup", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/NginxDeploymentListResponse" } }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "Deployments_ListByResourceGroup": { "$ref": "./examples/Deployments_ListByResourceGroup.json" } } } }, "/providers/Nginx.NginxPlus/operations": { "get": { "tags": [ "NginxDeployment" ], "summary": "List all operations provided by Nginx.NginxPlus for the 2021-05-01-preview api version.", "operationId": "Operations_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "Default error response.", "schema": { "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "Operations_List": { "$ref": "./examples/Operations_List.json" } } } } }, "definitions": { "ProvisioningState": { "enum": [ "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", "NotSpecified" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "ProvisioningState" } }, "NginxCertificateProperties": { "type": "object", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState" }, "keyVirtualPath": { "type": "string" }, "certificateVirtualPath": { "type": "string" }, "keyVaultSecretId": { "type": "string" } } }, "NginxCertificate": { "type": "object", "x-ms-azure-resource": true, "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "type": { "type": "string", "readOnly": true }, "properties": { "$ref": "#/definitions/NginxCertificateProperties" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "location": { "type": "string" }, "systemData": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", "readOnly": true } } }, "NginxCertificateListResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/NginxCertificate" } }, "nextLink": { "type": "string" } } }, "NginxConfigurationFile": { "type": "object", "properties": { "content": { "type": "string" }, "virtualPath": { "type": "string" } } }, "NginxConfigurationPackage": { "type": "object", "properties": { "data": { "type": "string" } } }, "NginxConfigurationProperties": { "type": "object", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState" }, "files": { "type": "array", "items": { "$ref": "#/definitions/NginxConfigurationFile" }, "x-ms-identifiers": [] }, "protectedFiles": { "type": "array", "items": { "$ref": "#/definitions/NginxConfigurationFile" }, "x-ms-identifiers": [] }, "package": { "$ref": "#/definitions/NginxConfigurationPackage" }, "rootFile": { "type": "string" } } }, "NginxConfiguration": { "type": "object", "x-ms-azure-resource": true, "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "type": { "type": "string", "readOnly": true }, "properties": { "$ref": "#/definitions/NginxConfigurationProperties" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "location": { "type": "string" }, "systemData": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", "readOnly": true } } }, "NginxConfigurationListResponse": { "description": "Response of a list operation.", "type": "object", "properties": { "value": { "description": "Results of a list operation.", "type": "array", "items": { "$ref": "#/definitions/NginxConfiguration" } }, "nextLink": { "description": "Link to the next set of results, if any.", "type": "string" } } }, "ErrorResponseBody": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "target": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/definitions/ErrorResponseBody" }, "x-ms-identifiers": [] } } }, "ResourceProviderDefaultErrorResponse": { "type": "object", "properties": { "error": { "$ref": "#/definitions/ErrorResponseBody" } } }, "IdentityType": { "enum": [ "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned", "None" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "IdentityType" } }, "UserIdentityProperties": { "type": "object", "properties": { "principalId": { "type": "string", "readOnly": true }, "clientId": { "type": "string", "readOnly": true } } }, "ResourceSku": { "required": [ "name" ], "type": "object", "properties": { "name": { "description": "Name of the SKU.", "type": "string" } } }, "IdentityProperties": { "type": "object", "properties": { "principalId": { "type": "string", "readOnly": true }, "tenantId": { "type": "string", "readOnly": true }, "type": { "$ref": "#/definitions/IdentityType" }, "userAssignedIdentities": { "type": "object", "additionalProperties": { "$ref": "#/definitions/UserIdentityProperties" } } } }, "NginxPrivateIPAllocationMethod": { "enum": [ "Static", "Dynamic" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "NginxPrivateIPAllocationMethod" } }, "NginxPrivateIPAddress": { "type": "object", "properties": { "privateIPAddress": { "type": "string" }, "privateIPAllocationMethod": { "$ref": "#/definitions/NginxPrivateIPAllocationMethod" }, "subnetId": { "type": "string" } } }, "NginxPublicIPAddress": { "type": "object", "properties": { "id": { "type": "string" } } }, "NginxFrontendIPConfiguration": { "type": "object", "properties": { "publicIPAddresses": { "type": "array", "items": { "$ref": "#/definitions/NginxPublicIPAddress" }, "x-ms-identifiers": [] }, "privateIPAddresses": { "type": "array", "items": { "$ref": "#/definitions/NginxPrivateIPAddress" }, "x-ms-identifiers": [] } } }, "NginxNetworkInterfaceConfiguration": { "type": "object", "properties": { "subnetId": { "type": "string" } } }, "NginxNetworkProfile": { "type": "object", "properties": { "frontEndIPConfiguration": { "$ref": "#/definitions/NginxFrontendIPConfiguration" }, "networkInterfaceConfiguration": { "$ref": "#/definitions/NginxNetworkInterfaceConfiguration" } } }, "NginxStorageAccount": { "type": "object", "properties": { "accountName": { "type": "string" }, "containerName": { "type": "string" } } }, "NginxLogging": { "type": "object", "properties": { "storageAccount": { "$ref": "#/definitions/NginxStorageAccount" } } }, "NginxDeploymentProperties": { "type": "object", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState" }, "nginxVersion": { "type": "string", "readOnly": true }, "managedResourceGroup": { "type": "string", "description": "The managed resource group to deploy VNet injection related network resources." }, "networkProfile": { "$ref": "#/definitions/NginxNetworkProfile" }, "ipAddress": { "type": "string", "description": "The IP address of the deployment.", "readOnly": true }, "enableDiagnosticsSupport": { "type": "boolean" }, "logging": { "$ref": "#/definitions/NginxLogging" } } }, "NginxDeployment": { "type": "object", "x-ms-azure-resource": true, "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "type": { "type": "string", "readOnly": true }, "identity": { "$ref": "#/definitions/IdentityProperties" }, "properties": { "$ref": "#/definitions/NginxDeploymentProperties" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "sku": { "$ref": "#/definitions/ResourceSku" }, "location": { "type": "string" }, "systemData": { "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", "readOnly": true } } }, "NginxDeploymentUpdateProperties": { "type": "object", "properties": { "enableDiagnosticsSupport": { "type": "boolean" }, "logging": { "$ref": "#/definitions/NginxLogging" } } }, "NginxDeploymentUpdateParameters": { "type": "object", "properties": { "identity": { "$ref": "#/definitions/IdentityProperties" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "sku": { "$ref": "#/definitions/ResourceSku" }, "location": { "type": "string" }, "properties": { "$ref": "#/definitions/NginxDeploymentUpdateProperties" } } }, "NginxDeploymentListResponse": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/NginxDeployment" } }, "nextLink": { "type": "string" } } }, "OperationDisplay": { "description": "The object that represents the operation.", "type": "object", "properties": { "provider": { "description": "Service provider: Nginx.NginxPlus", "type": "string" }, "resource": { "description": "Type on which the operation is performed, e.g., 'deployments'.", "type": "string" }, "operation": { "description": "Operation type, e.g., read, write, delete, etc.", "type": "string" }, "description": { "description": "Description of the operation, e.g., 'Write deployments'.", "type": "string" } } }, "OperationResult": { "description": "A Nginx.NginxPlus REST API operation.", "type": "object", "properties": { "name": { "description": "Operation name: {provider}/{resource}/{operation}", "type": "string" }, "display": { "description": "The object that represents the operation.", "$ref": "#/definitions/OperationDisplay" }, "isDataAction": { "description": "Indicates whether the operation is a data action", "type": "boolean" } } }, "OperationListResult": { "description": "Result of GET request to list Nginx.NginxPlus operations.", "type": "object", "properties": { "value": { "description": "List of operations supported by the Nginx.NginxPlus provider.", "type": "array", "items": { "$ref": "#/definitions/OperationResult" }, "x-ms-identifiers": [] }, "nextLink": { "description": "URL to get the next set of operation list results if there are any.", "type": "string" } } } }, "parameters": { "DeploymentNameParameter": { "in": "path", "name": "deploymentName", "description": "The name of targeted Nginx deployment", "required": true, "type": "string", "x-ms-parameter-location": "method" } } }