swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector CertificateOrders API
schemes:
- https
tags:
- name: CertificateOrders
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}
  : get:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Get Certificate Associated With The Certificate Order
      operationId: microsoftAzureCertificateordersGetcertificate
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: certificateOrderName
        in: path
        description: Certificate name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate name
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CertificateOrderCertificate'
      deprecated: false
      description: Needs a more full description created.
    put:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Associates A Key Vault Secret To A Certificate Store That Will Be Used For Storing The Certificate Once It S Ready
      operationId: microsoftAzureCertificateordersCreateorupdatecertificate
      consumes:
      - application/json
      - text/json
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: certificateOrderName
        in: path
        description: Certificate name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate name
        required: true
        type: string
      - name: keyVaultCertificate
        in: body
        description: Key Vault secret csm Id
        required: true
        schema:
          $ref: '#/definitions/CertificateOrderCertificate'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CertificateOrderCertificate'
      deprecated: false
      description: Needs a more full description created.
    delete:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Deletes The Certificate Associated With The Certificate Order
      operationId: microsoftAzureCertificateordersDeletecertificate
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: certificateOrderName
        in: path
        description: Certificate name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate name
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Object'
      deprecated: false
      description: Needs a more full description created.
    patch:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Associates A Key Vault Secret To A Certificate Store That Will Be Used For Storing The Certificate Once It S Ready
      operationId: microsoftAzureCertificateordersUpdatecertificate
      consumes:
      - application/json
      - text/json
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: certificateOrderName
        in: path
        description: Certificate name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate name
        required: true
        type: string
      - name: keyVaultCertificate
        in: body
        description: Key Vault secret csm Id
        required: true
        schema:
          $ref: '#/definitions/CertificateOrderCertificate'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CertificateOrderCertificate'
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}
  : get:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Get A Certificate Order
      operationId: microsoftAzureCertificateordersGetcertificateorder
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate name
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CertificateOrder'
      deprecated: false
      description: Needs a more full description created.
    put:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Create Or Update A Certificate Purchase Order
      operationId: microsoftAzureCertificateordersCreateorupdatecertificateorder
      consumes:
      - application/json
      - text/json
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate name
        required: true
        type: string
      - name: certificateDistinguishedName
        in: body
        description: Distinguished name to be used for purchasing certificate
        required: true
        schema:
          $ref: '#/definitions/CertificateOrder'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CertificateOrder'
      deprecated: false
      description: Needs a more full description created.
    delete:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Delete An Existing Certificate Order
      operationId: microsoftAzureCertificateordersDeletecertificateorder
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate name
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Object'
      deprecated: false
      description: Needs a more full description created.
    patch:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Create Or Update A Certificate Purchase Order
      operationId: microsoftAzureCertificateordersUpdatecertificateorder
      consumes:
      - application/json
      - text/json
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate name
        required: true
        type: string
      - name: certificateDistinguishedName
        in: body
        description: Distinguished name to be used for purchasing certificate
        required: true
        schema:
          $ref: '#/definitions/CertificateOrder'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CertificateOrder'
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders
  : get:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Get Certificate Orders In A Resource Group
      operationId: microsoftAzureCertificateordersGetcertificateorders
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CertificateOrderCollection'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates
  : get:
      tags:
      - CertificateOrders
      summary: Microsoft Azure List All Certificates Associated With A Certificate Order Only One Certificate Can Be Associated With An Order At A Time
      operationId: microsoftAzureCertificateordersGetcertificates
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: certificateOrderName
        in: path
        description: Certificate name
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CertificateOrderCertificateCollection'
      deprecated: false
      x-ms-pageable:
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/reissue
  : post:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Reissue An Existing Certificate Order
      operationId: microsoftAzureCertificateordersReissuecertificateorder
      consumes:
      - application/json
      - text/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate name
        required: true
        type: string
      - name: reissueCertificateOrderRequest
        in: body
        description: Reissue parameters
        required: true
        schema:
          $ref: '#/definitions/ReissueCertificateOrderRequest'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Object'
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/renew
  : post:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Renew An Existing Certificate Order
      operationId: microsoftAzureCertificateordersRenewcertificateorder
      consumes:
      - application/json
      - text/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate name
        required: true
        type: string
      - name: renewCertificateOrderRequest
        in: body
        description: Renew parameters
        required: true
        schema:
          $ref: '#/definitions/RenewCertificateOrderRequest'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Object'
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/retrieveCertificateActions
  : post:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Retrieve The List Of Certificate Actions
      operationId: microsoftAzureCertificateordersRetrievecertificateactions
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate order name
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/CertificateOrderAction'
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/retrieveEmailHistory
  : post:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Retrieve Email History
      operationId: microsoftAzureCertificateordersRetrievecertificateemailhistory
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate order name
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/CertificateEmail'
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/resendEmail
  : post:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Resend Certificate Email
      operationId: microsoftAzureCertificateordersResendcertificateemail
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate order name
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Object'
      deprecated: false
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/verifyDomainOwnership
  : post:
      tags:
      - CertificateOrders
      summary: Microsoft Azure Verify Domain Ownership For This Certificate Order
      operationId: microsoftAzureCertificateordersVerifydomainownership
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: resourceGroupName
        in: path
        description: Azure resource group name
        required: true
        type: string
      - name: name
        in: path
        description: Certificate order name
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Object'
      deprecated: false
      description: Needs a more full description created.
definitions:
  RenewCertificateOrderRequest:
    description: Class representing certificate renew request
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        properties:
          keySize:
            format: int32
            description: Certificate Key Size
            type: integer
        x-ms-client-flatten: true
  CertificateEmail:
    description: Certificate Email
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        properties:
          emailId:
            description: Email id
            type: string
          timeStamp:
            format: date-time
            description: Time stamp
            type: string
        x-ms-client-flatten: true
  ReissueCertificateOrderRequest:
    description: Class representing certificate reissue request
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        properties:
          keySize:
            format: int32
            description: Certificate Key Size
            type: integer
          delayExistingRevokeInHours:
            format: int32
            description: Delay in hours to revoke existing certificate after the new certificate is issued
            type: integer
        x-ms-client-flatten: true
  CertificateOrder:
    description: Certificate purchase order
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        properties:
          certificates:
            description: State of the Key Vault secret
            type: object
            additionalProperties:
              $ref: '#/definitions/CertificateOrderCertificate'
          distinguishedName:
            description: Certificate distinguished name
            type: string
          domainVerificationToken:
            description: Domain Verification Token
            type: string
          validityInYears:
            format: int32
            description: Duration in years (must be between 1 and 3)
            type: integer
          keySize:
            format: int32
            description: Certificate Key Size
            type: integer
          productType:
            description: Certificate product type
            enum:
            - StandardDomainValidatedSsl
            - StandardDomainValidatedWildCardSsl
            type: string
            x-ms-enum:
              name: CertificateProductType
              modelAsString: false
          autoRenew:
            description: Auto renew
            type: boolean
          provisioningState:
            description: Status of certificate order
            enum:
            - Succeeded
            - Failed
            - Canceled
            - InProgress
            - Deleting
            type: string
            x-ms-enum:
              name: ProvisioningState
              modelAsString: false
          status:
            description: Current order status
            enum:
            - Pendingissuance
            - Issued
            - Revoked
            - Canceled
            - Denied
            - Pendingrevocation
            - PendingRekey
            - Unused
            - Expired
            - NotSubmitted
            type: string
            x-ms-enum:
              name: CertificateOrderStatus
              modelAsString: false
          signedCertificate:
            $ref: '#/definitions/CertificateDetails'
            description: Signed certificate
          csr:
            description: Last CSR that was created for this order
            type: string
          intermediate:
            $ref: '#/definitions/CertificateDetails'
            description: Intermediate certificate
          root:
            $ref: '#/definitions/CertificateDetails'
            description: Root certificate
          serialNumber:
            description: Current serial number of the certificate
            type: string
          lastCertificateIssuanceTime:
            format: date-time
            description: Certificate last issuance time
            type: string
          expirationTime:
            format: date-time
            description: Certificate expiration time
            type: string
        x-ms-client-flatten: true
  Resource:
    required:
    - location
    properties:
      id:
        description: Resource Id
        type: string
      name:
        description: Resource Name
        type: string
      kind:
        description: Kind of resource
        type: string
      location:
        description: Resource Location
        type: string
      type:
        description: Resource type
        type: string
      tags:
        description: Resource tags
        type: object
        additionalProperties:
          type: string
    x-ms-azure-resource: true
  CertificateOrderCertificate:
    description: Class representing the Key Vault container for certificate purchased through Azure
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        properties:
          keyVaultId:
            description: Key Vault Csm resource Id
            type: string
          keyVaultSecretName:
            description: Key Vault secret name
            type: string
          provisioningState:
            description: Status of the Key Vault secret
            enum:
            - Initialized
            - WaitingOnCertificateOrder
            - Succeeded
            - CertificateOrderFailed
            - OperationNotPermittedOnKeyVault
            - AzureServiceUnauthorizedToAccessKeyVault
            - KeyVaultDoesNotExist
            - KeyVaultSecretDoesNotExist
            - UnknownError
            - Unknown
            type: string
            x-ms-enum:
              name: KeyVaultSecretStatus
              modelAsString: false
        x-ms-client-flatten: true
  CertificateDetails:
    description: Certificate Details
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        properties:
          version:
            format: int32
            description: Version
            type: integer
          serialNumber:
            description: Serial Number
            type: string
          thumbprint:
            description: Thumbprint
            type: string
          subject:
            description: Subject
            type: string
          notBefore:
            format: date-time
            description: Valid from
            type: string
          notAfter:
            format: date-time
            description: Valid to
            type: string
          signatureAlgorithm:
            description: Signature Algorithm
            type: string
          issuer:
            description: Issuer
            type: string
          rawData:
            description: Raw certificate data
            type: string
        x-ms-client-flatten: true
  Object:
    type: object
    properties: {}
  CertificateOrderAction:
    description: Represents a certificate action
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        required:
        - type
        properties:
          type:
            description: Type
            enum:
            - CertificateIssued
            - CertificateOrderCanceled
            - CertificateOrderCreated
            - CertificateRevoked
            - DomainValidationComplete
            - FraudDetected
            - OrgNameChange
            - OrgValidationComplete
            - SanDrop
            type: string
            x-ms-enum:
              name: CertificateOrderActionType
              modelAsString: false
          createdAt:
            format: date-time
            description: Time at which the certificate action was performed
            type: string
        x-ms-client-flatten: true
  CertificateOrderCollection:
    description: Collection of certificate orders
    type: object
    properties:
      value:
        description: Collection of resources
        type: array
        items:
          $ref: '#/definitions/CertificateOrder'
      nextLink:
        description: Link to next page of resources
        type: string
  CertificateOrderCertificateCollection:
    description: Collection of certificate order certificates
    type: object
    properties:
      value:
        description: Collection of resources
        type: array
        items:
          $ref: '#/definitions/CertificateOrderCertificate'
      nextLink:
        description: Link to next page of resources
        type: string
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Subscription Id
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    description: API Version
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'