swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NginxDeployment API
schemes:
- https
tags:
- name: NginxDeployment
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}
  : get:
      tags:
      - NginxDeployment
      summary: Microsoft Azure Get The Nginx Deployment
      operationId: microsoftAzureDeploymentsGet
      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/NginxDeployment'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/ResourceProviderDefaultErrorResponse'
      x-ms-examples:
        Deployments_Get:
          $ref: ./examples/Deployments_Get.json
      description: Needs a more full description created.
    put:
      tags:
      - NginxDeployment
      summary: Microsoft Azure Create Or Update The Nginx Deployment
      operationId: microsoftAzureDeploymentsCreate
      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'
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - 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
      description: Needs a more full description created.
    patch:
      tags:
      - NginxDeployment
      summary: Microsoft Azure Update The Nginx Deployment
      operationId: microsoftAzureDeploymentsUpdate
      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'
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - 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
      description: Needs a more full description created.
    delete:
      tags:
      - NginxDeployment
      summary: Microsoft Azure Delete The Nginx Deployment Resource
      operationId: microsoftAzureDeploymentsDelete
      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
        '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
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/providers/Nginx.NginxPlus/nginxDeployments:
    get:
      tags:
      - NginxDeployment
      summary: Microsoft Azure List The Nginx Deployments Resources
      operationId: microsoftAzureDeploymentsList
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      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
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments:
    get:
      tags:
      - NginxDeployment
      summary: Microsoft Azure List All Nginx Deployments Under The Specified Resource Group
      operationId: microsoftAzureDeploymentsListbyresourcegroup
      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: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      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
      description: Needs a more full description created.
  /providers/Nginx.NginxPlus/operations:
    get:
      tags:
      - NginxDeployment
      summary: Microsoft Azure List All Operations Provided By Nginx Nginxplus For The 2021 05 01 Preview Api Version
      operationId: microsoftAzureOperationsList
      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
      description: Needs a more full description created.
definitions:
  NginxLogging:
    type: object
    properties:
      storageAccount:
        $ref: '#/definitions/NginxStorageAccount'
  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
  ResourceSku:
    required:
    - name
    type: object
    properties:
      name:
        description: Name of the SKU.
        type: string
  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'
  NginxNetworkInterfaceConfiguration:
    type: object
    properties:
      subnetId:
        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: []
  NginxNetworkProfile:
    type: object
    properties:
      frontEndIPConfiguration:
        $ref: '#/definitions/NginxFrontendIPConfiguration'
      networkInterfaceConfiguration:
        $ref: '#/definitions/NginxNetworkInterfaceConfiguration'
  NginxPrivateIPAddress:
    type: object
    properties:
      privateIPAddress:
        type: string
      privateIPAllocationMethod:
        $ref: '#/definitions/NginxPrivateIPAllocationMethod'
      subnetId:
        type: string
  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
  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'
  NginxPublicIPAddress:
    type: object
    properties:
      id:
        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'
  IdentityType:
    enum:
    - SystemAssigned
    - UserAssigned
    - SystemAssigned, UserAssigned
    - None
    type: string
    x-ms-enum:
      modelAsString: true
      name: IdentityType
  ErrorResponseBody:
    type: object
    properties:
      code:
        type: string
      message:
        type: string
      target:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/ErrorResponseBody'
        x-ms-identifiers: []
  UserIdentityProperties:
    type: object
    properties:
      principalId:
        type: string
        readOnly: true
      clientId:
        type: string
        readOnly: true
  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
  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
  NginxPrivateIPAllocationMethod:
    enum:
    - Static
    - Dynamic
    type: string
    x-ms-enum:
      modelAsString: true
      name: NginxPrivateIPAllocationMethod
  NginxDeploymentListResponse:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/NginxDeployment'
      nextLink:
        type: string
  ProvisioningState:
    enum:
    - Accepted
    - Creating
    - Updating
    - Deleting
    - Succeeded
    - Failed
    - Canceled
    - Deleted
    - NotSpecified
    type: string
    readOnly: true
    x-ms-enum:
      modelAsString: true
      name: ProvisioningState
  NginxStorageAccount:
    type: object
    properties:
      accountName:
        type: string
      containerName:
        type: string
  ResourceProviderDefaultErrorResponse:
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorResponseBody'
  NginxDeploymentUpdateProperties:
    type: object
    properties:
      enableDiagnosticsSupport:
        type: boolean
      logging:
        $ref: '#/definitions/NginxLogging'
parameters:
  DeploymentNameParameter:
    in: path
    name: deploymentName
    description: The name of targeted Nginx deployment
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'